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

Interface	osid.offering.rules.CanonicalUnitProcessorCatalogueSession
Implements	`osid.OsidSession`
Description	This session provides methods to retrieve `CanonicalUnitProcessor` to `Catalogue` mappings. A `CanonicalUnitProcessor` may appear in multiple `Catalogue` objects. Each catalogue may have its own authorizations governing who is allowed to look at it. 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
Method	canLookupCanonicalUnitProcessorCatalogueMappings
Description	Tests if this user can perform lookups of canonical unit processor/catalogue 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	useComparativeCanonicalUnitProcessorCatalogueView
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	usePlenaryCanonicalUnitProcessorCatalogueView
Description	A complete view of the `CanonicalUnitProcessor` and `Catalogue` 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	getCanonicalUnitProcessorIdsByCatalogue
Description	Gets the list of `CanonicalUnitProcessorIds` associated with a `Catalogue.`
Parameters	`osid.id.Id`	`catalogueId`	`Id` of the `Catalogue`
Return	`osid.id.IdList`		list of related canonical unit processor `Ids`
Errors	NOT_FOUND		`catalogueId` is not found
	NULL_ARGUMENT		`catalogueId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getCanonicalUnitProcessorsByCatalogue
Description	Gets the list of canonical unit processors associated with a `Catalogue.`
Parameters	`osid.id.Id`	`catalogueId`	`Id` of the `Catalogue`
Return	`osid.offering.rules.CanonicalUnitProcessorList`		list of related canonical unit processors
Errors	NOT_FOUND		`catalogueId` is not found
	NULL_ARGUMENT		`catalogueId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getCanonicalUnitProcessorIdsByCatalogues
Description	Gets the list of `CanonicalUnitProcessor Ids` corresponding to a list of `Catalogues.`
Parameters	`osid.id.IdList`	`catalogueIds`	list of catalogue `Ids`
Return	`osid.id.IdList`		list of canonical unit processor `Ids`
Errors	NULL_ARGUMENT		`catalogueIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getCanonicalUnitProcessorsByCatalogues
Description	Gets the list of canonical unit processor corresponding to a list of `Catalogues.`
Parameters	`osid.id.IdList`	`catalogueIds`	list of catalogue `Ids`
Return	`osid.offering.rules.CanonicalUnitProcessorList`		list of canonical unit processors
Errors	NULL_ARGUMENT		`catalogueIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getCatalogueIdsByCanonicalUnitProcessor
Description	Gets the `Catalogue` `Ids` mapped to a `CanonicalUnitProcessor.`
Parameters	`osid.id.Id`	`canonicalUnitProcessorId`	`Id` of a `CanonicalUnitProcessor`
Return	`osid.id.IdList`		list of catalogues
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	getCataloguesByCanonicalUnitProcessor
Description	Gets the `Catalogues` mapped to a `CanonicalUnitProcessor.`
Parameters	`osid.id.Id`	`canonicalUnitProcessorId`	`Id` of a `CanonicalUnitProcessor`
Return	`osid.offering.CatalogueList`		list of catalogues
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.