OSID Logo
OSID Specifications
repository rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.repository.rules.CompositionEnablerRuleLookupSession
Implementsosid.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.
MethodgetRepositoryId
Description

Gets the Repository Id associated with this session.

Returnosid.id.Idthe Repository Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetRepository
Description

Gets the Repository associated with this session.

Returnosid.repository.Repositorythe repository
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanLookupCompositionEnablerRules
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.

Returnboolean false if looking up mappings is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseComparativeCompositionEnablerRuleView
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.

CompliancemandatoryThis method is must be implemented.
MethodusePlenaryCompositionEnablerRuleView
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.

CompliancemandatoryThis method is must be implemented.
MethoduseFederatedRepositoryView
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.

CompliancemandatoryThis method is must be implemented.
MethoduseIsolatedRepositoryView
Description

Isolates the view for methods in this session. An isolated view restricts lookups to this repository only.

CompliancemandatoryThis method is must be implemented.
MethodgetCompositionEnablerIdsForComposition
Description

Gets the CompositionEnabler Id associated with a Composition.

Parametersosid.id.Id compositionId Id of the Composition
Returnosid.id.IdListthe composition enabler Ids
ErrorsNOT_FOUND compositionId is not found
NULL_ARGUMENT compositionId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetCompositionEnablersForComposition
Description

Gets the CompositionEnabler associated with a Composition.

Parametersosid.id.IdcompositionId Id of the Composition
Returnosid.repository.rules.CompositionEnablerListthe composition enablers
ErrorsNOT_FOUND compositionId is not found
NULL_ARGUMENT compositionId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetCompositionIdsByCompositionEnabler
Description

Gets the Composition Ids mapped to a CompositionEnabler.

Parametersosid.id.IdcompositionEnablerId Id of a CompositionEnabler
Returnosid.id.IdListlist of composition Ids
ErrorsNOT_FOUND compositionEnablerId is not found
NULL_ARGUMENT compositionEnablerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetCompositionsByCompositionEnabler
Description

Gets the Compositions mapped to a CompositionEnabler.

Parametersosid.id.IdcompositionEnablerId Id of a CompositionEnabler
Returnosid.repository.CompositionListlist of compositions
ErrorsNOT_FOUND compositionEnablerId is not found
NULL_ARGUMENT compositionEnablerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.