OSID - osid.provisioning.ProvisionReturn Service Interface Definition

Interface	osid.provisioning.ProvisionReturn
Implements	`osid.OsidObject`
Implements	`osid.Subjugateable`
Used By	`osid.provisioning.Provision`
Used By	`osid.provisioning.ProvisionReturnSession`
Description	A `ProvisionReturn` captures data related to the return of a provision.
Method	getReturnDate
Description	Gets the date returned. The return date is the effective end date of the provision when the return is processed.
Return	`osid.calendaring.DateTime`		the date returned
Compliance	`mandatory`		This method must be implemented.
Method	getReturnerId
Description	Gets the `Id` of the returner resource.
Return	`osid.id.Id`		the resource `Id`
Compliance	`mandatory`		This method must be implemented.
Method	getReturner
Description	Gets the returner.
Return	`osid.resource.Resource`		the returner
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	getReturningAgentId
Description	Gets the `Id` of the returning agent.
Return	`osid.id.Id`		the resource `Id`
Compliance	`mandatory`		This method must be implemented.
Method	getReturningAgent
Description	Gets the returning agent.
Return	`osid.authentication.Agent`		the agent
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	getProvisionReturnRecord
Description	Gets the provision return record corresponding to the given `ProvisionReturn` record `Type` . This method is used to retrieve an object implementing the requested record. The `provisionReturnRecordType` may be the `Type` returned in `getRecordTypes()` or any of its parents in a `Type` hierarchy where `hasRecordType(provisionReturnRecordType)` is `true` .
Parameters	`osid.type.Type`	`provisionReturnRecordType`	the type of provision return record to retrieve
Return	`osid.provisioning.records.ProvisionReturnRecord`		the provision return record
Errors	NULL_ARGUMENT		`provisionReturnRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(provisionReturnRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.