OSID - osid.provisioning.MyProvisionSession Service Interface Definition

Interface	osid.provisioning.MyProvisionSession
Implements	`osid.OsidSession`
Description	This session defines methods for retrieving supplied provisions related to the queueing of the resource related to the authenticated agent. This lookup session defines several views: effective provision view: All lookup methods return provisions and requests where the current date falls in between the effective dates inclusive. any effective provision view: Provisions and requests of any effective date are returned from methods.
Method	getDistributorId
Description	Gets the `Distributor` `Id` associated with this session.
Return	`osid.id.Id`	the `Distributor Id` associated with this session
Compliance	`mandatory`	This method must be implemented.
Method	getDistributor
Description	Gets the `Distributor` associated with this session.
Return	`osid.provisioning.Distributor`	the distributor
Errors	OPERATION_FAILED	unable to complete request
Errors	PERMISSION_DENIED	authorization failure
Compliance	`mandatory`	This method must be implemented.
Method	canLookupMyProvision
Description	Tests if this user can perform `Provisions` lookups. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a `PERMISSION_DENIED.` This is intended as a hint to an application that may not offer lookup operations to unauthorized users.
Return	`boolean`	`false` if lookup methods are not authorized, `true` otherwise
Compliance	`mandatory`	This method must be implemented.
Method	useEffectiveProvisionView
Description	Only provisionables requests and pools whose effective dates are current are returned by methods in this session.
Compliance	`mandatory`	This method is must be implemented.
Method	useAnyEffectiveProvisionView
Description	All provisionables requests and pools of any effective dates are returned by methods in this session.
Compliance	`mandatory`	This method is must be implemented.
Method	getMyProvisions
Description	Gets the provisions for the resource related to this agent.
Return	`osid.provisioning.ProvisionList`	the returned `ProvisionList`
Errors	OPERATION_FAILED	unable to complete request
Errors	PERMISSION_DENIED	authorization failure
Compliance	`mandatory`	This method must be implemented.
Method	getMyQueues
Description	Gets all the queues in which the resource related to the authenticated agent is on.
Return	`osid.provisioning.QueueList`	the returned `Queue` list
Errors	OPERATION_FAILED	unable to complete request
Errors	PERMISSION_DENIED	authorization failure
Compliance	`mandatory`	This method must be implemented.
Method	getMyRequests
Description	Gets all the requests in which the resource related to the authenticated agent.
Return	`osid.provisioning.RequestList`	the returned `Request` list
Errors	OPERATION_FAILED	unable to complete request
Errors	PERMISSION_DENIED	authorization failure
Compliance	`mandatory`	This method must be implemented.