OSID Logo
OSID Specifications
provisioning package
Version 3.0.0
Release Candidate Preview
Interfaceosid.provisioning.Provisionable
Implementsosid.OsidRelationship
Description

An Provisionable is a provisionable resource. A provisionable is inactive if the pool is disabled.

MethodgetPoolId
Description

Gets the pool Id.

Returnosid.id.Idthe pool Id
CompliancemandatoryThis method must be implemented.
MethodgetPool
Description

Gets the pool.

Returnosid.provisioning.Poolthe pool
ErrorsOPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetResourceId
Description

Gets the resource Id.

Returnosid.id.Idthe resource Id
CompliancemandatoryThis method must be implemented.
MethodgetResource
Description

Gets the resource.

Returnosid.resource.Resourcethe resource
ErrorsOPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetUse
Description

Gets the number of times this provisionable has been provisioned.

Returncardinalthe position
CompliancemandatoryThis method must be implemented.
MethodgetProvisionableRecord
Description

Gets the provisionable record corresponding to the given Provisionable record Type. This method is used to retrieve an object implementing the requested record. The provisionableRecordType may be the Type returned in getRecordTypes() or any of its parents in a Type hierarchy where hasRecordType(provisionableRecordType) is true .

Parametersosid.type.TypeprovisionableRecordTypethe type of provisionable record to retrieve
Returnosid.provisioning.records.ProvisionableRecordthe provisionable record
ErrorsNULL_ARGUMENT provisionableRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(provisionableRecordType) is false
CompliancemandatoryThis method must be implemented.