Interface Provisionable

All Superinterfaces:
Browsable, Extensible, Identifiable, OsidObject, OsidRelationship, Temporal
public interface Provisionable extends OsidRelationship

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

  • Method Details

    • getPoolId

      Id getPoolId()
      Gets the pool Id.
      Returns:
      the pool Id
      Compliance:
      mandatory - This method must be implemented.

    • getPool

      Pool getPool() throws OperationFailedException
      Gets the pool.
      Returns:
      the pool
      Throws:
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • getResourceId

      Id getResourceId()
      Gets the resource Id.
      Returns:
      the resource Id
      Compliance:
      mandatory - This method must be implemented.

    • getResource

      Resource getResource() throws OperationFailedException
      Gets the resource.
      Returns:
      the resource
      Throws:
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • getUse

      long getUse()
      Gets the number of times this provisionable has been provisioned.
      Returns:
      the position
      Compliance:
      mandatory - This method must be implemented.

    • getProvisionableRecord

      ProvisionableRecord getProvisionableRecord(Type provisionableRecordType) throws OperationFailedException
      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.
      Parameters:
      provisionableRecordType - the type of provisionable record to retrieve
      Returns:
      the provisionable record
      Throws:
      NullArgumentException - provisionableRecordType is null
      OperationFailedException - unable to complete request
      UnsupportedException - hasRecordType(provisionableRecordType) is false
      Compliance:
      mandatory - This method must be implemented.