OSID - osid.provisioning.ProvisionLookupSession Service Interface Definition

Interface	osid.provisioning.ProvisionLookupSession
Implements	`osid.OsidSession`
Description	This session provides methods for retrieving `Provision` objects. The `Provision` represents a fixed connection between two `Provisions.` This session defines views that offer differing behaviors when retrieving multiple objects. comparative view: elements may be silently omitted or re-ordered plenary view: provides a complete set or is an error condition isolated distributor view: All provision methods in this session operate, retrieve and pertain to provisions defined explicitly in the current distributor. Using an isolated view is useful for managing `Provisions` with the `ProvisionAdminSession.` federated distributor view: All provision methods in this session operate, retrieve and pertain to all provisions defined in this distributor and any other provisions implicitly available in this distributor through distributor inheritence. effective provision view: All provision lookup methods return provisions where the current date falls in between the effective dates inclusive. any effective provision view: Provisions of any effective date are returned from methods. Generally, the comparative view should be used for most applications as it permits operation even if there is data that cannot be accessed. The methods `useFederatedDistributorView()` and `useIsolatedDistributorView()` behave as a radio group and one should be selected before invoking any lookup 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	canLookupProvisions
Description	Tests if this user can perform `Provision` 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 opt not to 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	useComparativeProvisionView
Description	The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision.
Compliance	`mandatory`		This method is must be implemented.
Method	usePlenaryProvisionView
Description	A complete view of the `Provision` returns is desired. Methods will return what is requested or result in an error. This view is used when greater precision is desired at the expense of interoperability.
Compliance	`mandatory`		This method is must be implemented.
Method	useFederatedDistributorView
Description	Federates the view for methods in this session. A federated view will include provisions in distributors which are children of this distributor in the distributor hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedDistributorView
Description	Isolates the view for methods in this session. An isolated view restricts lookups to this distributor only.
Compliance	`mandatory`		This method is must be implemented.
Method	useEffectiveProvisionView
Description	Only provisions whose effective dates are current are returned by methods in this session.
Compliance	`mandatory`		This method is must be implemented.
Method	useAnyEffectiveProvisionView
Description	All provisions of any effective dates are returned by methods in this session.
Compliance	`mandatory`		This method is must be implemented.
Method	getProvision
Description	Gets the `Provision` specified by its `Id.` In plenary mode, the exact `Id` is found or a `NOT_FOUND` results. Otherwise, the returned `Provision` may have a different `Id` than requested, such as the case where a duplicate `Id` was assigned to a `Provision` and retained for compatibility. In effective mode, provisions are returned that are currently effective. In any effective mode, effective provisions and those currently expired are returned.
Parameters	`osid.id.Id`	`provisionId`	`Id` of the `Provision`
Return	`osid.provisioning.Provision`		the provision
Errors	NOT_FOUND		`provisionId` not found
	NULL_ARGUMENT		`provisionId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method is must be implemented.
Method	getProvisionsByIds
Description	Gets a `ProvisionList` corresponding to the given `IdList.` In plenary mode, the returned list contains all of the provisions specified in the `Id` list, in the order of the list, including duplicates, or an error results if an `Id` in the supplied list is not found or inaccessible. Otherwise, inaccessible `Provisions` may be omitted from the list and may present the elements in any order including returning a unique set. In effective mode, provisions are returned that are currently effective. In any effective mode, effective provisions and those currently expired are returned.
Parameters	`osid.id.IdList`	`provisionIds`	the list of `Ids` to retrieve
Return	`osid.provisioning.ProvisionList`		the returned `Provision` list
Errors	NOT_FOUND		an `Id` was not found
	NULL_ARGUMENT		`provisionIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getProvisionsByGenusType
Description	Gets a `ProvisionList` corresponding to the given provision genus `Type` which does not include provisions of genus types derived from the specified `Type.` In plenary mode, the returned list contains all known provisions or an error results. Otherwise, the returned list may contain only those provisions that are accessible through this session. In effective mode, provisions are returned that are currently effective. In any effective mode, effective provisions and those currently expired are returned.
Parameters	`osid.type.Type`	`provisionGenusType`	a provision genus type
Return	`osid.provisioning.ProvisionList`		the returned `Provision` list
Errors	NULL_ARGUMENT		`provisionGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getProvisionsByParentGenusType
Description	Gets a `ProvisionList` corresponding to the given provision genus `Type` and include any additional provisions with genus types derived from the specified `Type.` In plenary mode, the returned list contains all known provisions or an error results. Otherwise, the returned list may contain only those provisions that are accessible through this session. In effective mode, provisions are returned that are currently effective. In any effective mode, effective provisions and those currently expired are returned.
Parameters	`osid.type.Type`	`provisionGenusType`	a provision genus type
Return	`osid.provisioning.ProvisionList`		the returned `Provision` list
Errors	NULL_ARGUMENT		`provisionGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getProvisionsByRecordType
Description	Gets a `ProvisionList` containing the given provision record `Type.` In plenary mode, the returned list contains all known provisions or an error results. Otherwise, the returned list may contain only those provisions that are accessible through this session. In effective mode, provisions are returned that are currently effective. In any effective mode, effective provisions and those currently expired are returned.
Parameters	`osid.type.Type`	`provisionRecordType`	a provision record type
Return	`osid.provisioning.ProvisionList`		the returned `Provision` list
Errors	NULL_ARGUMENT		`provisionRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getProvisionsOnDate
Description	Gets a list of provisions effective during the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known provisions or an error results. Otherwise, the returned list may contain only those provisions that are accessible through this session. In effective mode, provisions are returned that are currently effective in addition to being effective in the guven date range. In any effective mode, effective provisions and those currently expired are returned.
Parameters	`osid.calendaring.DateTime`	`from`	start of date range
Parameters	`osid.calendaring.DateTime`	`to`	end of date range
Return	`osid.provisioning.ProvisionList`		the returned `Provision` list
Errors	INVALID_ARGUMENT		`from` is greater than `to`
	NULL_ARGUMENT		`from` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getProvisionsForBroker
Description	Gets a list of provisions for a supplied broker. In plenary mode, the returned list contains all known provisions or an error results. Otherwise, the returned list may contain only those provisions that are accessible through this session. In effective mode, provisions are returned that are currently effective. In any effective mode, effective provisions and those currently expired are returned.
Parameters	`osid.id.Id`	`brokerId`	a broker `Id`
Return	`osid.provisioning.ProvisionList`		the returned `Provision` list
Errors	NULL_ARGUMENT		`brokerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getProvisionsForBrokerOnDate
Description	Gets a list of provisions for a supplied broker. and effective during the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known provisions or an error results. Otherwise, the returned list may contain only those provisions that are accessible through this session. In effective mode, provisions are returned that are currently effective in addition to being effective in the guven date range. In any effective mode, effective provisions and those currently expired are returned.
Parameters	`osid.id.Id`	`brokerId`	a broker `Id`
	`osid.calendaring.DateTime`	`from`	start of date range
	`osid.calendaring.DateTime`	`to`	end of date range
Return	`osid.provisioning.ProvisionList`		the returned `Provision` list
Errors	INVALID_ARGUMENT		`from` is greater than `to`
	NULL_ARGUMENT		`brokerId, from` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getProvisionsForProvisionable
Description	Gets a list of provisions for a provisionable. In plenary mode, the returned list contains all known provisions or an error results. Otherwise, the returned list may contain only those provisions that are accessible through this session. In effective mode, provisions are returned that are currently effective. In any effective mode, effective provisions and those currently expired are returned.
Parameters	`osid.id.Id`	`provisionableId`	a provisionable `Id`
Return	`osid.provisioning.ProvisionList`		the returned `Provision` list
Errors	NULL_ARGUMENT		`provisionableId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getProvisionsForProvisionableOnDate
Description	Gets a list of provisions for a provisionable and effective during the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known provisions or an error results. Otherwise, the returned list may contain only those provisions that are accessible through this session. In effective mode, provisions are returned that are currently effective in addition to being effective in the guven date range. In any effective mode, effective provisions and those currently expired are returned.
Parameters	`osid.id.Id`	`provisionableId`	a provisionable `Id`
	`osid.calendaring.DateTime`	`from`	start of date range
	`osid.calendaring.DateTime`	`to`	end of date range
Return	`osid.provisioning.ProvisionList`		the returned `Provision` list
Errors	INVALID_ARGUMENT		`from` is greater than `to`
	NULL_ARGUMENT		`provisionableId, from` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getProvisionsForRecipient
Description	Gets a list of provisions for a recipient resource. In plenary mode, the returned list contains all known provisions or an error results. Otherwise, the returned list may contain only those provisions that are accessible through this session. In effective mode, provisions are returned that are currently effective. In any effective mode, effective provisions and those currently expired are returned.
Parameters	`osid.id.Id`	`resourceId`	a resource `Id`
Return	`osid.provisioning.ProvisionList`		the returned `Provision` list
Errors	NULL_ARGUMENT		`resourceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getProvisionsForRecipientOnDate
Description	Gets a list of provisions for a recipient resource and effective during the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known provisions or an error results. Otherwise, the returned list may contain only those provisions that are accessible through this session. In effective mode, provisions are returned that are currently effective in addition to being effective in the guven date range. In any effective mode, effective provisions and those currently expired are returned.
Parameters	`osid.id.Id`	`resourceId`	a resource `Id`
	`osid.calendaring.DateTime`	`from`	start of date range
	`osid.calendaring.DateTime`	`to`	end of date range
Return	`osid.provisioning.ProvisionList`		the returned `Provision` list
Errors	INVALID_ARGUMENT		`from` is greater than `to`
	NULL_ARGUMENT		`resourceId, from` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getProvisionsForProvisionableAndRecipient
Description	Gets a list of provisions for a resource and recipient. In plenary mode, the returned list contains all known provisions or an error results. Otherwise, the returned list may contain only those provisions that are accessible through this session. In effective mode, provisions are returned that are currently effective. In any effective mode, effective provisions and those currently expired are returned.
Parameters	`osid.id.Id`	`provisionableId`	a provisionable `Id`
Parameters	`osid.id.Id`	`recipientId`	a recipient resource `Id`
Return	`osid.provisioning.ProvisionList`		the returned `Provision` list
Errors	NULL_ARGUMENT		`provisionableId` or `recipientId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getProvisionsForProvisionableAndRecipientOnDate
Description	Gets a list of provisions for a resource and request and effective during the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known provisions or an error results. Otherwise, the returned list may contain only those provisions that are accessible through this session. In effective mode, provisions are returned that are currently effective in addition to being effective in the guven date range. In any effective mode, effective provisions and those currently expired are returned.
Parameters	`osid.id.Id`	`provisionableId`	a provisionable `Id`
	`osid.id.Id`	`recipientId`	a recipient resource `Id`
	`osid.calendaring.DateTime`	`from`	start of date range
	`osid.calendaring.DateTime`	`to`	end of date range
Return	`osid.provisioning.ProvisionList`		the returned `Provision` list
Errors	INVALID_ARGUMENT		`from` is greater than `to`
	NULL_ARGUMENT		`provisionableId, recipientId, from` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getProvisionsForRequest
Description	Gets a list of provisions for a request. In plenary mode, the returned list contains all known provisions or an error results. Otherwise, the returned list may contain only those provisions that are accessible through this session. In effective mode, provisions are returned that are currently effective. In any effective mode, effective provisions and those currently expired are returned.
Parameters	`osid.id.Id`	`requestId`	a request `Id`
Return	`osid.provisioning.ProvisionList`		the returned `Provision` list
Errors	NULL_ARGUMENT		`requestId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getProvisions
Description	Gets all `Provisions.` In plenary mode, the returned list contains all known provisions or an error results. Otherwise, the returned list may contain only those provisions that are accessible through this session. In effective mode, provisions are returned that are currently effective. In any effective mode, effective provisions and those currently expired are returned.
Return	`osid.provisioning.ProvisionList`		a list of `Provisions`
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.