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 Summary

Modifier and Type	Method	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.

Methods inherited from interface Browsable

getProperties, getPropertiesByRecordType

Modifier and Type	Method	Description
PropertyList	getProperties()	Gets a list of properties.
PropertyList	getPropertiesByRecordType(Type recordType)	Gets a list of properties corresponding to the specified record type.

Methods inherited from interface Extensible

getRecordTypes, hasRecordType

Modifier and Type	Method	Description
TypeList	getRecordTypes()	Gets the record types available in this object.
boolean	hasRecordType(Type recordType)	Tests if this object supports the given record Type .

Methods inherited from interface Identifiable

getId, isCurrent

Modifier and Type	Method	Description
Id	getId()	Gets the Id associated with this instance of this OSID object.
boolean	isCurrent()	Tests to see if the last method invoked retrieved up-to-date data.

Methods inherited from interface OsidObject

getDescription, getDisplayName, getGenusType, isOfGenusType

Modifier and Type	Method	Description
DisplayText	getDescription()	Gets the description associated with this instance of this OSID object.
DisplayText	getDisplayName()	Gets the preferred display name associated with this instance of this OSID object appropriate for display to the user.
Type	getGenusType()	Gets the genus type of this object.
boolean	isOfGenusType(Type genusType)	Tests if this object is of the given genus Type .

Methods inherited from interface OsidRelationship

getEndReason, getEndReasonId, hasEndReason

Modifier and Type	Method	Description
State	getEndReason()	Gets a state indicating why this relationship has ended.
Id	getEndReasonId()	Gets a state Id indicating why this relationship has ended.
boolean	hasEndReason()	Tests if a reason this relationship came to an end is known.

Methods inherited from interface Temporal

getEndDate, getStartDate, isEffective

Modifier and Type	Method	Description
DateTime	getEndDate()	Gets the end date.
DateTime	getStartDate()	Gets the start date.
boolean	isEffective()	Tests if the current date is within the start end end dates inclusive.

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.