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

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

A complete view of the Composition 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.
MethodcanLookupCompositionRepositoryMappings
Description

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

Gets the list of Composition Ids associated with a Repository.

Parametersosid.id.IdrepositoryId Id of the Repository
Returnosid.id.IdListlist of related composition 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.
MethodgetCompositionsByRepository
Description

Gets the list of Compositions associated with a Repository.

Parametersosid.id.IdrepositoryId Id of the Repository
Returnosid.repository.CompositionListlist of related compositions
ErrorsNOT_FOUND repositoryId is not found
NULL_ARGUMENT repositoryId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetCompositionIdsByRepositories
Description

Gets the list of Composition Ids corresponding to a list of Repository objects

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

Gets the list of Compositions corresponding to a list of Repository objects

Parametersosid.id.IdListrepositoryIdslist of repository Ids
Returnosid.repository.CompositionListlist of Compositions
ErrorsNULL_ARGUMENT repositoryIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetRepositoryIdsByComposition
Description

Gets the Repository Ids mapped to a Composition.

Parametersosid.id.IdcompositionId Id of a Composition
Returnosid.id.IdListlist of repository 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.
MethodgetRepositoriesByComposition
Description

Gets the Repository objects mapped to a Composition.

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