OSID - osid.offering.rules.CanonicalUnitProcessorLookupSession Service Interface Definition

Interface	osid.offering.rules.CanonicalUnitProcessorLookupSession
Implements	`osid.OsidSession`
Description	This session provides methods for retrieving `CanonicalUnitProcessors.` 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 catalogue view: All canonical unit processor methods in this session operate, retrieve and pertain to canonical unit processor defined explicitly in the current catalogue. Using an isolated view is useful for managing `CanonicalUnitProcessors` with the `CanonicalUnitProcessorAdminSession.` federated catalogue view: All canonical unit processor methods in this session operate, retrieve and pertain to all canonical unit processor defined in this catalogue and any other canonical unit processor implicitly available in this catalogue through catalogue inheritence. active canonical unit processor view: All canonical unit processor lookup methods return active canonical unit processors. any status canonical unit processor view: CanonicalUnit processors of any active or inactive status 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 the methods in this session.
Method	getCatalogueId
Description	Gets the `Catalogue` `Id` associated with this session.
Return	`osid.id.Id`		the `Catalogue Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getCatalogue
Description	Gets the `Catalogue` associated with this session.
Return	`osid.offering.Catalogue`		the catalogue
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canLookupCanonicalUnitProcessors
Description	Tests if this user can perform `CanonicalUnitProcessors` 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	useComparativeCanonicalUnitProcessorView
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	usePlenaryCanonicalUnitProcessorView
Description	A complete view of the `CanonicalUnitProcessor` 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	useFederatedCatalogueView
Description	Federates the view for methods in this session. A federated view will include canonical unit processor in catalogues which are children of this catalogue in the catalogue hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedCatalogueView
Description	Isolates the view for methods in this session. An isolated view restricts lookups to this catalogue only.
Compliance	`mandatory`		This method is must be implemented.
Method	useActiveCanonicalUnitProcessorView
Description	Only active canonical unit processors are returned by methods in this session.
Compliance	`mandatory`		This method is must be implemented.
Method	useAnyStatusCanonicalUnitProcessorView
Description	All active and inactive canonical unit processors are returned by methods in this session.
Compliance	`mandatory`		This method is must be implemented.
Method	getCanonicalUnitProcessor
Description	Gets the `CanonicalUnitProcessor` specified by its `Id.` In plenary mode, the exact `Id` is found or a `NOT_FOUND` results. Otherwise, the returned `CanonicalUnitProcessor` may have a different `Id` than requested, such as the case where a duplicate `Id` was assigned to a `CanonicalUnitProcessor` and retained for compatibility. In active mode, canonical unit processors are returned that are currently active. In any status mode, active and inactive canonical unit processors are returned.
Parameters	`osid.id.Id`	`canonicalUnitProcessorId`	`Id` of the `CanonicalUnitProcessor`
Return	`osid.offering.rules.CanonicalUnitProcessor`		the canonical unit processor
Errors	NOT_FOUND		`canonicalUnitProcessorId` not found
	NULL_ARGUMENT		`canonicalUnitProcessorId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method is must be implemented.
Method	getCanonicalUnitProcessorsByIds
Description	Gets a `CanonicalUnitProcessorList` corresponding to the given `IdList.` In plenary mode, the returned list contains all of the canonical unit processor 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 `CanonicalUnitProcessors` may be omitted from the list and may present the elements in any order including returning a unique set. In active mode, canonical unit processors are returned that are currently active. In any status mode, active and inactive canonical unit processors are returned.
Parameters	`osid.id.IdList`	`canonicalUnitProcessorIds`	the list of `Ids` to retrieve
Return	`osid.offering.rules.CanonicalUnitProcessorList`		the returned `CanonicalUnitProcessor` list
Errors	NOT_FOUND		an `Id was` not found
	NULL_ARGUMENT		`canonicalUnitProcessorIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getCanonicalUnitProcessorsByGenusType
Description	Gets a `CanonicalUnitProcessorList` corresponding to the given canonical unit processor genus `Type` which does not include canonical unit processor of genus types derived from the specified `Type.` In plenary mode, the returned list contains all known canonical unit processor or an error results. Otherwise, the returned list may contain only those canonical unit processor that are accessible through this session. In active mode, canonical unit processors are returned that are currently active. In any status mode, active and inactive canonical unit processors are returned.
Parameters	`osid.type.Type`	`canonicalUnitProcessorGenusType`	a canonical unit processor genus type
Return	`osid.offering.rules.CanonicalUnitProcessorList`		the returned `CanonicalUnitProcessor` list
Errors	NULL_ARGUMENT		`canonicalUnitProcessorGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getCanonicalUnitProcessorsByParentGenusType
Description	Gets a `CanonicalUnitProcessorList` corresponding to the given canonical unit processor genus `Type` and include any additional canonical unit processor with genus types derived from the specified `Type.` In plenary mode, the returned list contains all known canonical unit processor or an error results. Otherwise, the returned list may contain only those canonical unit processor that are accessible through this session. In active mode, canonical unit processors are returned that are currently active. In any status mode, active and inactive canonical unit processors are returned.
Parameters	`osid.type.Type`	`canonicalUnitProcessorGenusType`	a canonical unit processor genus type
Return	`osid.offering.rules.CanonicalUnitProcessorList`		the returned `CanonicalUnitProcessor` list
Errors	NULL_ARGUMENT		`canonicalUnitProcessorGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getCanonicalUnitProcessorsByRecordType
Description	Gets a `CanonicalUnitProcessorList` containing the given canonical unit processor record `Type.` In plenary mode, the returned list contains all known canonical unit processor or an error results. Otherwise, the returned list may contain only those canonical unit processor that are accessible through this session. In active mode, canonical unit processors are returned that are currently active. In any status mode, active and inactive canonical unit processors are returned.
Parameters	`osid.type.Type`	`canonicalUnitProcessorRecordType`	a canonical unit processor record type
Return	`osid.offering.rules.CanonicalUnitProcessorList`		the returned `CanonicalUnitProcessor` list
Errors	NULL_ARGUMENT		`canonicalUnitProcessorRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getCanonicalUnitProcessors
Description	Gets all `CanonicalUnitProcessors.` In plenary mode, the returned list contains all known canonical unit processor or an error results. Otherwise, the returned list may contain only those canonical unit processor that are accessible through this session. In active mode, canonical unit processors are returned that are currently active. In any status mode, active and inactive canonical unit processors are returned.
Return	`osid.offering.rules.CanonicalUnitProcessorList`		the returned `CanonicalUnitProcessor` list
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.