OSID Logo
OSID Specifications
repository rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.repository.rules.CompositionEnablerRepositorySession
Implementsosid.OsidSession
Description

This session provides methods to retrieve CompositionEnabler to Composition mappings. A CompositionEnabler may appear in multiple Composition objects. Each composition 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
MethodcanLookupCompositionEnablerRepositorytMappings
Description

Tests if this user can perform lookups of composition enabler/repository 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.
MethoduseComparativeCompositionEnablerRepositoryView
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.
MethodusePlenaryCompositionEnablerRepositoryView
Description

A complete view of the CompositionEnabler and Repository 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.
MethodgetCompositionEnablerIdsByRepository
Description

Gets the list of CompositionEnablerIds associated with a Repository.

Parametersosid.id.IdrepositoryId Id of the Repository
Returnosid.id.IdListlist of related composition enabler Ids
ErrorsNOT_FOUND repositoryId is not found
NULL_ARGUMENT repositoryId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetCompositionEnablersByRepository
Description

Gets the list of composition enablers associated with a Repository.

Parametersosid.id.IdrepositoryId Id of the Repository
Returnosid.repository.rules.CompositionEnablerListlist of related composition enablers
ErrorsNOT_FOUND repositoryId is not found
NULL_ARGUMENT repositoryId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetCompositionEnablerIdsByRepositories
Description

Gets the list of CompositionEnabler Ids corresponding to a list of Repositories.

Parametersosid.id.IdListrepositoryIdslist of repository Ids
Returnosid.id.IdListlist of composition enabler Ids
ErrorsNULL_ARGUMENT familtIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetCompositionEnablersByRepositories
Description

Gets the list of composition enablers corresponding to a list of Repositories.

Parametersosid.id.IdListrepositoryIdslist of repository Ids
Returnosid.repository.rules.CompositionEnablerListlist of composition enablers
ErrorsNULL_ARGUMENT repositoryIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetRepositoryIdsByCompositionEnabler
Description

Gets the Repository Ids mapped to a CompositionEnabler.

Parametersosid.id.IdcompositionEnablerId Id of a CompositionEnabler
Returnosid.id.IdListlist of repository 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 repositories mapped to a CompositionEnabler.

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