OSID - osid.provisioning.Provision Service Interface Definition

Interface	osid.provisioning.Provision
Implements	`osid.OsidRelationship`
Used By	`osid.provisioning.ProvisionAdminSession`
	`osid.provisioning.ProvisionList`
	`osid.provisioning.ProvisionLookupSession`
	`osid.provisioning.Request`
Description	A `Provision` is a relationship between a provisionable and a recipient governed by a broker.
Method	getBrokerId
Description	Gets the `Id` of the broker.
Return	`osid.id.Id`		the broker `Id`
Compliance	`mandatory`		This method must be implemented.
Method	getBroker
Description	Gets the broker.
Return	`osid.provisioning.Broker`		the broker
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	getProvisionableId
Description	Gets the `Id` of the provisionable.
Return	`osid.id.Id`		the provisionable `Id`
Compliance	`mandatory`		This method must be implemented.
Method	getProvisionable
Description	Gets the provisionable.
Return	`osid.provisioning.Provisionable`		the provisionable
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	getRecipientId
Description	Gets the `Id` of the recipient.
Return	`osid.id.Id`		the resource `Id`
Compliance	`mandatory`		This method must be implemented.
Method	getRecipient
Description	Gets the recipient.
Return	`osid.resource.Resource`		the resource
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	provisionedByRequest
Description	Tests if this provision has a request.
Return	`boolean`		`true` if a request is available, false otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getRequestId
Description	Gets the `Id` of the request.
Return	`osid.id.Id`		the request `Id`
Errors	ILLEGAL_STATE		`provisionedByRequest()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	getRequest
Description	Gets the request.
Return	`osid.provisioning.Request`		the request
Errors	ILLEGAL_STATE		`provisionedByRequest()` is `false`
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	getProvisionDate
Description	Gets the date this was provisioned. The provision date may differ from the effective dates of this provision.
Return	`osid.calendaring.DateTime`		the provision date
Compliance	`mandatory`		This method must be implemented.
Method	isLeased
Description	Tests if this provision is temporary. The lease ends when the provision expires or is returned.
Return	`boolean`		`true` if this is a lease, `false` if the provision is permanent
Compliance	`mandatory`		This method must be implemented.
Method	mustReturn
Description	Tests if this provision is must be returned.
Return	`boolean`		`true` if this is must be returned, `false` otherwise
Errors	ILLEGAL_STATE		`isLeased()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	hasDueDate
Description	Tests if this provision is must be returned and has a due date.
Return	`boolean`		`true` if this is must be returned, `false` otherwise
Errors	ILLEGAL_STATE		`mustReturn()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	getDueDate
Description	Gets the due date for the return.
Return	`osid.calendaring.DateTime`		the due date
Errors	ILLEGAL_STATE		`hasDueDate()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	hasCost
Description	Tests if this provision has a total cost. If this is a lease with an expected return than it is the cost for the time period.
Return	`boolean`		`true` if there is a cost, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getCost
Description	Gets the cost.
Return	`osid.financials.Currency`		the cost
Errors	ILLEGAL_STATE		`hasCost()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	hasRate
Description	Tests if this provision has a rate per time period.
Return	`boolean`		`true` if there is a rate, false otherwise
Errors	ILLEGAL_STATE		`hasRate()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	getRateAmount
Description	Gets the rate amount.
Return	`osid.financials.Currency`		the rate amount
Errors	ILLEGAL_STATE		`hasRate()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	getRatePeriod
Description	Gets the rate period.
Return	`osid.calendaring.Duration`		the time period
Errors	ILLEGAL_STATE		`hasRate()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	isReturned
Description	Tests if this provision has been returned.
Return	`boolean`		`true` if this provision has been returned, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getProvisionReturn
Description	Gets the provision return that has any data that may have been captured in the return process.
Return	`osid.provisioning.ProvisionReturn`		the return
Errors	ILLEGAL_STATE		`isReturned()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	getProvisionRecord
Description	Gets the provision record corresponding to the given `Provision` record `Type`. This method is used to retrieve an object implementing the requested record. The `provisionRecordType` may be the `Type` returned in `getRecordTypes()` or any of its parents in a `Type` hierarchy where `hasRecordType(provisionRecordType)` is `true`.
Parameters	`osid.type.Type`	`provisionRecordType`	the type of provision record to retrieve
Return	`osid.provisioning.records.ProvisionRecord`		the provision record
Errors	NULL_ARGUMENT		`provisionRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`hasRecordType(provisionRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.