public interface Provisionable extends OsidRelationship
An Provisionable
is a provisionable resource. A
provisionable is inactive if the pool is disabled.
Modifier and Type | Method and Description |
---|---|
Pool |
getPool()
Gets the pool.
|
Id |
getPoolId()
Gets the pool
Id. |
ProvisionableRecord |
getProvisionableRecord(Type provisionableRecordType)
Gets the provisionable record corresponding to the given
Provisionable record Type. |
Resource |
getResource()
Gets the resource.
|
Id |
getResourceId()
Gets the resource
Id. |
long |
getUse()
Gets the number of times this provisionable has been provisioned.
|
getEndReason, getEndReasonId, hasEndReason
getDescription, getDisplayName, getGenusType, isOfGenusType
getId, isCurrent
getRecordTypes, hasRecordType
getProperties, getPropertiesByRecordType
getEndDate, getStartDate, isEffective
Id getPoolId()
Id.
Id
mandatory
- This method must be implemented. Pool getPool() throws OperationFailedException
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. Id getResourceId()
Id.
Id
mandatory
- This method must be implemented. Resource getResource() throws OperationFailedException
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. long getUse()
mandatory
- This method must be implemented. ProvisionableRecord getProvisionableRecord(Type provisionableRecordType) throws OperationFailedException
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
.provisionableRecordType
- the type of provisionable record to
retrieveNullArgumentException
- provisionableRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(provisionableRecordType)
is false
mandatory
- This method must be implemented.