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

Interface	osid.repository.rules.CompositionEnablerRuleLookupSession
Implements	`osid.OsidSession`
Description	This session provides methods to retrieve `CompositionEnabler` to `Composition` mappings. A `Composition` with multiple `CompositionEnablers` means any positive rule evaluation across the enablers result in a visible `Composition` node. 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 repository view: All methods in this session operate, retrieve and pertain composition enablers defined explicitly in the current repository. federated repository view: All methods in this session operate, retrieve and pertain to all composition enablers defined in this repository and any other repository enablers implicitly available in this repository through repository inheritence.
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	canLookupCompositionEnablerRules
Description	Tests if this user can perform lookups of composition enabler/composition 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	useComparativeCompositionEnablerRuleView
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	usePlenaryCompositionEnablerRuleView
Description	A complete view of the `CompositionEnabler` and `Composition` 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	getCompositionEnablerIdsForComposition
Description	Gets the `CompositionEnabler Id` associated with a `Composition.`
Parameters	`osid.id.Id`	`compositionId`	`Id` of the `Composition`
Return	`osid.id.IdList`		the composition enabler `Ids`
Errors	NOT_FOUND		`compositionId` is not found
	NULL_ARGUMENT		`compositionId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getCompositionEnablersForComposition
Description	Gets the `CompositionEnabler` associated with a `Composition.`
Parameters	`osid.id.Id`	`compositionId`	`Id` of the `Composition`
Return	`osid.repository.rules.CompositionEnablerList`		the composition enablers
Errors	NOT_FOUND		`compositionId` is not found
	NULL_ARGUMENT		`compositionId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getCompositionIdsByCompositionEnabler
Description	Gets the `Composition` `Ids` mapped to a `CompositionEnabler.`
Parameters	`osid.id.Id`	`compositionEnablerId`	`Id` of a `CompositionEnabler`
Return	`osid.id.IdList`		list of composition `Ids`
Errors	NOT_FOUND		`compositionEnablerId` is not found
	NULL_ARGUMENT		`compositionEnablerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getCompositionsByCompositionEnabler
Description	Gets the `Compositions` mapped to a `CompositionEnabler.`
Parameters	`osid.id.Id`	`compositionEnablerId`	`Id` of a `CompositionEnabler`
Return	`osid.repository.CompositionList`		list of compositions
Errors	NOT_FOUND		`compositionEnablerId` is not found
	NULL_ARGUMENT		`compositionEnablerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.