OSID - osid.provisioning.ProvisionableLookupSession Service Interface Definition

Interface	osid.provisioning.ProvisionableLookupSession
Implements	`osid.OsidSession`
Description	This session defines methods for retrieving provisionables. This lookup session defines several views: comparative view: elements may be silently omitted or re-ordered plenary view: provides a complete result set or is an error condition isolated distributor view: All provisionable methods in this session operate, retrieve and pertain to provisionables defined explicitly in the current distributor. Using an isolated view is useful for managing `Provisionables` with the `ProvisionableAdminSession.` federated distributor view: All provisionable lookup methods in this session operate, retrieve and pertain to all provisionables defined in this distributor and any other provisionables implicitly available in this distributor through distributor inheritence. effective provisionable view: All provisionable lookup methods return provisionables where the current date falls in between the effective dates inclusive. any effective provisionable view: provisionables of any effective date are returned from methods. The methods `useFederatedDistributorView()` and `useIsolatedDistributorView()` behave as a radio group and one should be selected before invoking any lookup methods. Provisionables may have an additional records indicated by their respective record types. The record may not be accessed through a cast of the provisionables.
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	canLookupProvisionables
Description	Tests if this user can perform `Provisionable` 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	useComparativeProvisionableView
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	usePlenaryProvisionableView
Description	A complete view of the `Provisionable` 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 provisionables 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 retrievals to this distributor only.
Compliance	`mandatory`		This method is must be implemented.
Method	useEffectiveProvisionableView
Description	Only provisionables whose effective dates are current are returned by methods in this session.
Compliance	`mandatory`		This method is must be implemented.
Method	useAnyEffectiveProvisionableView
Description	All provisionables of any effective dates are returned by methods in this session.
Compliance	`mandatory`		This method is must be implemented.
Method	getProvisionable
Description	Gets the `Provisionable` specified by its `Id.` In plenary mode, the exact `Id` is found or a `NOT_FOUND` results. Otherwise, the returned `Provisionable` may have a different `Id` than requested, such as the case where a duplicate `Id` was assigned to a `Provisionable` and retained for compatibility. In effective mode, provisionables are returned that are currently effective. In any effective mode, effective provisionables and those currently expired are returned.
Parameters	`osid.id.Id`	`provisionableId`	the `Id` of the `Provisionable` to retrieve
Return	`osid.provisioning.Provisionable`		the returned `Provisionable`
Errors	NOT_FOUND		no `Provisionable` found with the given `Id`
	NULL_ARGUMENT		`provisionableId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getProvisionablesByIds
Description	Gets a `ProvisionableList` corresponding to the given `IdList.` In plenary mode, the returned list contains all of the provisionables 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 `Provisionables` may be omitted from the list and may present the elements in any order including returning a unique set. In effective mode, provisionables are returned that are currently effective. In any effective mode, effective provisionables and those currently expired are returned.
Parameters	`osid.id.IdList`	`provisionableIds`	the list of `Ids` to retrieve
Return	`osid.provisioning.ProvisionableList`		the returned `Provisionable` list
Errors	NOT_FOUND		an `Id` was not found
	NULL_ARGUMENT		`provisionableIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getProvisionablesByGenusType
Description	Gets a `ProvisionableList` corresponding to the given provisionable genus `Type` which does not include provisionables of types derived from the specified `Type.` In plenary mode, the returned list contains all known provisionables or an error results. Otherwise, the returned list may contain only those provisionables that are accessible through this session. In effective mode, provisionables are returned that are currently effective. In any effective mode, effective provisionables and those currently expired are returned.
Parameters	`osid.type.Type`	`provisionableGenusType`	a provisionable genus type
Return	`osid.provisioning.ProvisionableList`		the returned `Provisionable` list
Errors	NULL_ARGUMENT		`provisionableGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getProvisionablesByParentGenusType
Description	Gets a `ProvisionableList` corresponding to the given provisionable genus `Type` and include any additional provisionables with genus types derived from the specified `Type.` In plenary mode, the returned list contains all known provisionables or an error results. Otherwise, the returned list may contain only those provisionables that are accessible through this session. In effective mode, provisionables are returned that are currently effective. In any effective mode, effective provisionables and those currently expired are returned.
Parameters	`osid.type.Type`	`provisionableGenusType`	a provisionable genus type
Return	`osid.provisioning.ProvisionableList`		the returned `Provisionable` list
Errors	NULL_ARGUMENT		`provisionableGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getProvisionablesByRecordType
Description	Gets a `ProvisionableList` containing the given provisionable record `Type.` In plenary mode, the returned list contains all known provisionables or an error results. Otherwise, the returned list may contain only those provisionables that are accessible through this session. In effective mode, provisionables are returned that are currently effective. In any effective mode, effective provisionables and those currently expired are returned.
Parameters	`osid.type.Type`	`provisionableRecordType`	a provisionable record type
Return	`osid.provisioning.ProvisionableList`		the returned `Provisionable` list
Errors	NULL_ARGUMENT		`provisionableRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getProvisionablesOnDate
Description	Gets a list of provisionables effective during the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known provisionables or an error results. Otherwise, the returned list may contain only those provisionables that are accessible through this session. In effective mode, provisionables are returned that are currently effective in addition to being effective in the given date range. In any effective mode, effective provisionables 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.ProvisionableList`		the returned `Provisionable` 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	getProvisionablesForResource
Description	Gets a list of provisionables for a resource. In plenary mode, the returned list contains all known provisionables or an error results. Otherwise, the returned list may contain only those provisionables that are accessible through this session. In effective mode, provisionables are returned that are currently effective. In any effective mode, effective provisionables and those currently expired are returned.
Parameters	`osid.id.Id`	`resourceId`	a resource `Id`
Return	`osid.provisioning.ProvisionableList`		the returned `Provisionable` 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	getProvisionablesForResourceOnDate
Description	Gets a list of provisionables for a 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 provisionables or an error results. Otherwise, the returned list may contain only those provisionables that are accessible through this session. In effective mode, provisionables are returned that are currently effective in addition to being effective in the given date range. In any effective mode, effective provisionables 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.ProvisionableList`		the returned `Provisionable` 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	getProvisionablesForPool
Description	Gets a list of provisionables for a pool. In plenary mode, the returned list contains all known provisionables or an error results. Otherwise, the returned list may contain only those provisionables that are accessible through this session. In effective mode, provisionables are returned that are currently effective. In any effective mode, effective provisionables and those currently expired are returned.
Parameters	`osid.id.Id`	`poolId`	a pool `Id`
Return	`osid.provisioning.ProvisionableList`		the returned `Provisionable` list
Errors	NULL_ARGUMENT		`poolId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getProvisionablesForPoolOnDate
Description	Gets a list of provisionables effective during the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known provisionables or an error results. Otherwise, the returned list may contain only those provisionables that are accessible through this session. In effective mode, provisionables are returned that are currently effective in addition to being effective in the given date range. In any effective mode, effective provisionables and those currently expired are returned.
Parameters	`osid.id.Id`	`poolId`	a pool `Id`
	`osid.calendaring.DateTime`	`from`	start of date range
	`osid.calendaring.DateTime`	`to`	end of date range
Return	`osid.provisioning.ProvisionableList`		the returned `Provisionable` list
Errors	INVALID_ARGUMENT		`from` is greater than `to`
	NULL_ARGUMENT		`poolId, from` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getProvisionablesForResourceAndPool
Description	Gets a list of provisionables for a resource and pool. In plenary mode, the returned list contains all known provisionables or an error results. Otherwise, the returned list may contain only those provisionables that are accessible through this session. In effective mode, provisionables are returned that are currently effective. In any effective mode, effective provisionables and those currently expired are returned.
Parameters	`osid.id.Id`	`resourceId`	a resource `Id`
Parameters	`osid.id.Id`	`poolId`	a pool `Id`
Return	`osid.provisioning.ProvisionableList`		the returned `Provisionable` list
Errors	NULL_ARGUMENT		`resourceId` or `poolId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getProvisionablesForResourceAndPoolOnDate
Description	Gets a list of provisionables effective during the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known provisionables or an error results. Otherwise, the returned list may contain only those provisionables that are accessible through this session. In effective mode, provisionables are returned that are currently effective in addition to being effective in the given date range. In any effective mode, effective provisionables and those currently expired are returned.
Parameters	`osid.id.Id`	`resourceId`	a resource `Id`
	`osid.id.Id`	`poolId`	a pool `Id`
	`osid.calendaring.DateTime`	`from`	start of date range
	`osid.calendaring.DateTime`	`to`	end of date range
Return	`osid.provisioning.ProvisionableList`		the returned `Provisionable` list
Errors	INVALID_ARGUMENT		`from` is greater than `to`
	NULL_ARGUMENT		`resourceId, poolId, from` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getProvisionables
Description	Gets all provisionables. In plenary mode, the returned list contains all of the provisionables including duplicates, or an error results if an `Id` in the supplied list is not found or inaccessible. Otherwise, inaccessible `Provisionables` may be omitted from the list and may present the elements in any order including returning a unique set. In effective mode, provisionables are returned that are currently effective. In any effective mode, effective provisionables and those currently expired are returned.
Return	`osid.provisioning.ProvisionableList`		the returned `Provisionable` list
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.