OSID - osid.offering.CanonicalUnitCatalogueSession Service Interface Definition

Interface	osid.offering.CanonicalUnitCatalogueSession
Implements	`osid.OsidSession`
Description	This session provides methods to retrieve `CanonicalUnit` to `Catalogue` mappings. A `CanonicalUnit` may appear in multiple `Catalogues.` 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	canLookupCanonicalUnitCatalogueMappings
Description	Tests if this user can perform lookups of canonical unit/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 intendedas 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	useComparativeCatalogueView
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	usePlenaryCatalogueView
Description	A complete view of the `CanonicalUnit` 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	getCanonicalUnitIdsByCatalogue
Description	Gets the list of CanonicalUnit Ids associated with a `Catalogue.`
Parameters	`osid.id.Id`	`catalogueId`	`Id` of a `Catalogues.`
Return	`osid.id.IdList`		list of related canonical unit `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	getCanonicalUnitsByCatalogue
Description	Gets the list of `CanonicalUnits` associated with a `Catalogue.`
Parameters	`osid.id.Id`	`catalogueId`	`Id` of a `Catalogue`
Return	`osid.offering.CanonicalUnitList`		list of related canonical units
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	getCanonicalUnitIdsByCatalogues
Description	Gets the list of `CanonicalUnit Ids` corresponding to a list of `Catalogue` objects.
Parameters	`osid.id.IdList`	`catalogueIds`	list of catalogue `Ids`
Return	`osid.id.IdList`		list of canonical unit `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	getCanonicalUnitsByCatalogues
Description	Gets the list of `CanonicalUnits` corresponding to a list of `Catalogues.`
Parameters	`osid.id.IdList`	`catalogueIds`	list of catalogue `Ids`
Return	`osid.offering.CanonicalUnitList`		list of canonical units
Errors	NULL_ARGUMENT		`catalogueIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getCatalogueIdsByCanonicalUnit
Description	Gets the list of `Catalogue` `Ids` mapped to a `CanonicalUnit.`
Parameters	`osid.id.Id`	`canonicalUnitId`	`Id` of a `CanonicalUnit`
Return	`osid.id.IdList`		list of catalogue `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	getCataloguesByCanonicalUnit
Description	Gets the list of `Catalogue` objects mapped to a `CanonicalUnit.`
Parameters	`osid.id.Id`	`canonicalUnitId`	`Id` of a `CanonicalUnit`
Return	`osid.offering.CatalogueList`		list of catalogues
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.