OSID - osid.repository.rules.CompositionEnablerLookupSession Service Interface Definition

Interface	osid.repository.rules.CompositionEnablerLookupSession
Implements	`osid.OsidSession`
Description	This session provides methods for retrieving `CompositionEnablers.` 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 repository view: All composition enabler methods in this session operate, retrieve and pertain to composition enablers defined explicitly in the current repository. Using an isolated view is useful for managing `CompositionEnablers` with the `CompositionEnablerAdminSession.` federated repository view: All composition enabler methods in this session operate, retrieve and pertain to all composition enablers defined in this repository and any other composition enablers implicitly available in this repository through repository inheritence. active composition enabler view: All composition enabler lookup methods return active composition enablers. any status composition enabler view: Composition enablers of any active or inactive status are returned from methods.
Method	getRepositoryId
Description	Gets the `Repository` `Id` associated with this session.
Return	`osid.id.Id`		the `Repository Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getRepository
Description	Gets the `Repository` associated with this session.
Return	`osid.repository.Repository`		the repository
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canLookupCompositionEnablers
Description	Tests if this user can perform `CompositionEnablers` 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	useComparativeCompositionEnablerView
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	usePlenaryCompositionEnablerView
Description	A complete view of the `CompositionEnabler` 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	useFederatedRepositoryView
Description	Federates the view for methods in this session. A federated view will include composition enablers in repositories which are children of this repository in the repository hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedRepositoryView
Description	Isolates the view for methods in this session. An isolated view restricts lookups to this repository only.
Compliance	`mandatory`		This method is must be implemented.
Method	useActiveCompositionEnablerView
Description	Only active composition enablers are returned by methods in this session.
Compliance	`mandatory`		This method is must be implemented.
Method	useAnyStatusCompositionEnablerView
Description	All active and inactive composition enablers are returned by methods in this session.
Compliance	`mandatory`		This method is must be implemented.
Method	getCompositionEnabler
Description	Gets the `CompositionEnabler` specified by its `Id.` In plenary mode, the exact `Id` is found or a `NOT_FOUND` results. Otherwise, the returned `CompositionEnabler` may have a different `Id` than requested, such as the case where a duplicate `Id` was assigned to a `CompositionEnabler` and retained for compatibility. In active mode, composition enablers are returned that are currently active in addition to being effective during the given date range. In any status mode, active and inactive composition enablers are returned.
Parameters	`osid.id.Id`	`compositionEnablerId`	`Id` of the `CompositionEnabler`
Return	`osid.repository.rules.CompositionEnabler`		the composition enabler
Errors	NOT_FOUND		`compositionEnablerId` not found
	NULL_ARGUMENT		`compositionEnablerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method is must be implemented.
Method	getCompositionEnablersByIds
Description	Gets a `CompositionEnablerList` corresponding to the given `IdList.` In plenary mode, the returned list contains all of the composition 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 `CompositionEnablers` may be omitted from the list and may present the elements in any order including returning a unique set. In active mode, composition enablers are returned that are currently active in addition to being effective during the given date range. In any status mode, active and inactive composition enablers are returned.
Parameters	`osid.id.IdList`	`compositionEnablerIds`	the list of `Ids` to retrieve
Return	`osid.repository.rules.CompositionEnablerList`		the returned `CompositionEnabler` list
Errors	NOT_FOUND		an `Id was` not found
	NULL_ARGUMENT		`compositionEnablerIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getCompositionEnablersByGenusType
Description	Gets a `CompositionEnablerList` corresponding to the given composition enabler genus `Type` which does not include composition enablers of genus types derived from the specified `Type.` In plenary mode, the returned list contains all known composition enablers or an error results. Otherwise, the returned list may contain only those composition enablers that are accessible through this session. In active mode, composition enablers are returned that are currently active in addition to being effective during the given date range. In any status mode, active and inactive composition enablers are returned.
Parameters	`osid.type.Type`	`compositionEnablerGenusType`	a composition enabler genus type
Return	`osid.repository.rules.CompositionEnablerList`		the returned `CompositionEnabler` list
Errors	NULL_ARGUMENT		`compositionEnablerGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getCompositionEnablersByParentGenusType
Description	Gets a `CompositionEnablerList` corresponding to the given composition enabler genus `Type` and include any additional composition enablers with genus types derived from the specified `Type.` In plenary mode, the returned list contains all known composition enablers or an error results. Otherwise, the returned list may contain only those composition enablers that are accessible through this session. In active mode, composition enablers are returned that are currently active in addition to being effective during the given date range. In any status mode, active and inactive composition enablers are returned.
Parameters	`osid.type.Type`	`compositionEnablerGenusType`	a composition enabler genus type
Return	`osid.repository.rules.CompositionEnablerList`		the returned `CompositionEnabler` list
Errors	NULL_ARGUMENT		`compositionEnablerGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getCompositionEnablersByRecordType
Description	Gets a `CompositionEnablerList` containing the given composition enabler record `Type.` In plenary mode, the returned list contains all known composition enablers or an error results. Otherwise, the returned list may contain only those composition enablers that are accessible through this session. In active mode, composition enablers are returned that are currently active in addition to being effective during the given date range. In any status mode, active and inactive composition enablers are returned.
Parameters	`osid.type.Type`	`compositionEnablerRecordType`	a composition enabler record type
Return	`osid.repository.rules.CompositionEnablerList`		the returned `CompositionEnabler` list
Errors	NULL_ARGUMENT		`compositionEnablerRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getCompositionEnablersOnDate
Description	Gets a `CompositionEnablerList` that are effective for the entire given date range inclusive but not confined to the date range for any agent. In plenary mode, the returned list contains all known composition enablers or an error results. Otherwise, the returned list may contain only those composition enablers that are accessible through this session. In active mode, composition enablers are returned that are currently active in addition to being effective during the given date range. In any status mode, active and inactive composition enablers are returned.
Parameters	`osid.calendaring.DateTime`	`from`	a start date
Parameters	`osid.calendaring.DateTime`	`to`	an end date
Return	`osid.repository.rules.CompositionEnablerList`		the returned `CompositionEnabler` 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	getCompositionEnablersOnDateWithAgent
Description	Gets a `CompositionEnablerList` that are effective for the entire given date range inclusive but not confined to the date range evaluated against the given agent. In plenary mode, the returned list contains all known composition enablers or an error results. Otherwise, the returned list may contain only those composition enablers that are accessible through this session. In active mode, composition enablers are returned that are currently active in addition to being effective during the given date range. In any status mode, active and inactive composition 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.repository.rules.CompositionEnablerList`		the returned `CompositionEnabler` 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	getCompositionEnablers
Description	Gets all `CompositionEnablers.` In plenary mode, the returned list contains all known composition enablers or an error results. Otherwise, the returned list may contain only those composition enablers that are accessible through this session. In active mode, composition enablers are returned that are currently active in addition to being effective during the given date range. In any status mode, active and inactive composition enablers are returned.
Return	`osid.repository.rules.CompositionEnablerList`		the returned `CompositionEnabler` list
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.