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

Interface	osid.offering.rules.CanonicalUnitProcessorRuleLookupSession
Implements	`osid.OsidSession`
Description	This session provides methods to retrieve `CanonicalUnitProcessor` to `CanonicalUnit` mappings. 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 catalogue view: All methods in this session operate, retrieve and pertain canonical unit processor defined explicitly in the current catalogue federated catalogue view: All 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.
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	canLookupCanonicalUnitProcessorRules
Description	Tests if this user can perform lookups of canonical unit processor/canonical unit mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known lookup 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 looking up mappings is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	useComparativeCanonicalUnitProcessorRuleView
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	usePlenaryCanonicalUnitProcessorRuleView
Description	A complete view of the `CanonicalUnitProcessor` and `CanonicalUnit` 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	getCanonicalUnitProcessorIdsForCanonicalUnit
Description	Gets the `CanonicalUnitProcessor Id` associated with a `CanonicalUnit.`
Parameters	`osid.id.Id`	`canonicalUnitId`	`Id` of the `CanonicalUnit`
Return	`osid.id.IdList`		the canonical unit processor `Ids`
Errors	NOT_FOUND		`canonicalUnitId` is not found
	NULL_ARGUMENT		`canonicalUnitId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getCanonicalUnitProcessorsForCanonicalUnit
Description	Gets the `CanonicalUnitProcessor` associated with a `CanonicalUnit.`
Parameters	`osid.id.Id`	`canonicalUnitId`	`Id` of the `CanonicalUnit`
Return	`osid.offering.rules.CanonicalUnitProcessorList`		the canonical unit processors
Errors	NOT_FOUND		`canonicalUnitId` is not found
	NULL_ARGUMENT		`canonicalUnitId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getCanonicalUnitIdsForCanonicalUnitProcessor
Description	Gets the `CanonicalUnit` `Ids` mapped to a `CanonicalUnitProcessor.`
Parameters	`osid.id.Id`	`canonicalUnitProcessorId`	`Id` of a `CanonicalUnitProcessor`
Return	`osid.id.IdList`		list of canonical unit `Ids`
Errors	NOT_FOUND		`canonicalUnitProcessorId` is not found
	NULL_ARGUMENT		`canonicalUnitProcessorId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getCanonicalUnitsForCanonicalUnitProcessor
Description	Gets the `CanonicalUnits` mapped to a `CanonicalUnitProcessor.`
Parameters	`osid.id.Id`	`canonicalUnitProcessorId`	`Id` of a `CanonicalUnitProcessor`
Return	`osid.offering.CanonicalUnitList`		list of canonicalUnits
Errors	NOT_FOUND		`canonicalUnitProcessorId` is not found
	NULL_ARGUMENT		`canonicalUnitProcessorId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.