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

Interface	osid.offering.rules.CanonicalUnitEnablerLookupSession
Implements	`osid.OsidSession`
Description	This session provides methods for retrieving `CanonicalUnitEnablers.` 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 enabler methods in this session operate, retrieve and pertain to canonical unit enablers defined explicitly in the current catalogue. Using an isolated view is useful for managing `CanonicalUnitEnablers` with the `CanonicalUnitEnablerAdminSession.` federated catalogue view: All canonical unit enabler methods in this session operate, retrieve and pertain to all canonical unit enablers defined in this catalogue and any other canonical unit enablers implicitly available in this catalogue through catalogue inheritence. activee canonical unit enabler view: All canonical unit enabler lookup methods return active canonical unit enablers. any status canonical unit enabler view: canonical unit enablers 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	canLookupCanonicalUnitEnablers
Description	Tests if this user can perform `CanonicalUnitEnablers` 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	useComparativeCanonicalUnitEnablerView
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	usePlenaryCanonicalUnitEnablerView
Description	A complete view of the `CanonicalUnitEnabler` 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 enablers 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	useActiveCanonicalUnitEnablerView
Description	Only active canonical unit enablers are returned by methods in this session.
Compliance	`mandatory`		This method is must be implemented.
Method	useAnyStatusCanonicalUnitEnablerView
Description	All active and inactive canonical unit enablers are returned by methods in this session.
Compliance	`mandatory`		This method is must be implemented.
Method	getCanonicalUnitEnabler
Description	Gets the `CanonicalUnitEnabler` specified by its `Id.` In plenary mode, the exact `Id` is found or a `NOT_FOUND` results. Otherwise, the returned `CanonicalUnitEnabler` may have a different `Id` than requested, such as the case where a duplicate `Id` was assigned to a `CanonicalUnitEnabler` and retained for compatibility. In active mode, canonical unit enablers are returned that are currently active. In any status mode, active and inactive canonical unit enablers are returned.
Parameters	`osid.id.Id`	`canonicalUnitEnablerId`	`Id` of the `CanonicalUnitEnabler`
Return	`osid.offering.rules.CanonicalUnitEnabler`		the canonical unit enabler
Errors	NOT_FOUND		`canonicalUnitEnablerId` not found
	NULL_ARGUMENT		`canonicalUnitEnablerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method is must be implemented.
Method	getCanonicalUnitEnablersByIds
Description	Gets a `CanonicalUnitEnablerList` corresponding to the given `IdList.` In plenary mode, the returned list contains all of the canonical unit enablers 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 `CanonicalUnitEnablers` may be omitted from the list and may present the elements in any order including returning a unique set. In active mode, canonical unit enablers are returned that are currently active. In any status mode, active and inactive canonical unit enablers are returned.
Parameters	`osid.id.IdList`	`canonicalUnitEnablerIds`	the list of `Ids` to retrieve
Return	`osid.offering.rules.CanonicalUnitEnablerList`		the returned `CanonicalUnitEnabler` list
Errors	NOT_FOUND		an `Id was` not found
	NULL_ARGUMENT		`canonicalUnitEnablerIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getCanonicalUnitEnablersByGenusType
Description	Gets a `CanonicalUnitEnablerList` corresponding to the given canonical unit enabler genus `Type` which does not include canonical unit enablers of genus types derived from the specified `Type.` In plenary mode, the returned list contains all known canonical unit enablers or an error results. Otherwise, the returned list may contain only those canonical unit enablers that are accessible through this session. In active mode, canonical unit enablers are returned that are currently active. In any status mode, active and inactive canonical unit enablers are returned.
Parameters	`osid.type.Type`	`canonicalUnitEnablerGenusType`	a canonical unit enabler genus type
Return	`osid.offering.rules.CanonicalUnitEnablerList`		the returned `CanonicalUnitEnabler` list
Errors	NULL_ARGUMENT		`canonicalUnitEnablerGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getCanonicalUnitEnablersByParentGenusType
Description	Gets a `CanonicalUnitEnablerList` corresponding to the given canonical unit enabler genus `Type` and include any additional canonical unit enablers with genus types derived from the specified `Type.` In plenary mode, the returned list contains all known canonical unit enablers or an error results. Otherwise, the returned list may contain only those canonical unit enablers that are accessible through this session. In active mode, canonical unit enablers are returned that are currently active. In any status mode, active and inactive canonical unit enablers are returned.
Parameters	`osid.type.Type`	`canonicalUnitEnablerGenusType`	a canonical unit enabler genus type
Return	`osid.offering.rules.CanonicalUnitEnablerList`		the returned `CanonicalUnitEnabler` list
Errors	NULL_ARGUMENT		`canonicalUnitEnablerGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getCanonicalUnitEnablersByRecordType
Description	Gets a `CanonicalUnitEnablerList` containing the given canonical unit enabler record `Type.` In plenary mode, the returned list contains all known canonical unit enablers or an error results. Otherwise, the returned list may contain only those canonical unit enablers that are accessible through this session. In active mode, canonical unit enablers are returned that are currently active. In any status mode, active and inactive canonical unit enablers are returned.
Parameters	`osid.type.Type`	`canonicalUnitEnablerRecordType`	a canonical unit enabler record type
Return	`osid.offering.rules.CanonicalUnitEnablerList`		the returned `CanonicalUnitEnabler` list
Errors	NULL_ARGUMENT		`canonicalUnitEnablerRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getCanonicalUnitEnablersOnDate
Description	Gets a `CanonicalUnitEnablerList` that are effective for the entire given date range but not confined to the date range. In plenary mode, the returned list contains all known canonical unit enablers or an error results. Otherwise, the returned list may contain only those canonical unit enablers that are accessible through this session. In active mode, canonical unit enablers are returned that are currently active in addition to being effective during the given date range. In any status mode, active and inactive canonical unit enablers are returned.
Parameters	`osid.calendaring.DateTime`	`from`	a start date
Parameters	`osid.calendaring.DateTime`	`to`	an end date
Return	`osid.offering.rules.CanonicalUnitEnablerList`		the returned `CanonicalUnitEnabler` 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	getCanonicalUnitEnablersOnDateWithAgent
Description	Gets a `CanonicalUnitEnablerList` that are effective for the entire given date range but not confined to the date range and evaluated against the given agent. In plenary mode, the returned list contains all known canonical unit enablers or an error results. Otherwise, the returned list may contain only those canonical unit enablers that are accessible through this session. In active mode, canonical unit enablers are returned that are currently active in addition to being effective during the given date range. In any status mode, active and inactive canonical unit enablers are returned.
Parameters	`osid.id.Id`	`agentId`	an agent Id
	`osid.calendaring.DateTime`	`from`	a start date
	`osid.calendaring.DateTime`	`to`	an end date
Return	`osid.offering.rules.CanonicalUnitEnablerList`		the returned `CanonicalUnitEnabler` list
Errors	INVALID_ARGUMENT		`from` is greater than `to`
	NULL_ARGUMENT		`agentId, from,` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getCanonicalUnitEnablers
Description	Gets all `CanonicalUnitEnablers.` In plenary mode, the returned list contains all known canonical unit enablers or an error results. Otherwise, the returned list may contain only those canonical unit enablers that are accessible through this session. In active mode, canonical unit enablers are returned that are currently active. In any status mode, active and inactive canonical unit enablers are returned.
Return	`osid.offering.rules.CanonicalUnitEnablerList`		the returned `CanonicalUnitEnabler` list
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.