public interface CompositionRepositorySession extends OsidSession
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:
Modifier and Type | Method and Description |
---|---|
boolean |
canLookupCompositionRepositoryMappings()
Tests if this user can perform lookups of composition/repository
mappings.
|
CompositionList |
getCompoitionsByRepositories(IdList repositoryIds)
Gets the list of
Compositions corresponding to a list
of Repository objects |
IdList |
getCompositionIdsByRepositories(IdList repositoryIds)
Gets the list of
Composition Ids
corresponding to a list of Repository objects |
IdList |
getCompositionIdsByRepository(Id repositoryId)
Gets the list of
Composition Ids
associated with a Repository. |
CompositionList |
getCompositionsByRepository(Id repositoryId)
Gets the list of
Compositions associated with a
Repository. |
RepositoryList |
getRepositoriesByComposition(Id compositionId)
Gets the
Repository objects mapped to a
Composition. |
IdList |
getRepositoryIdsByComposition(Id compositionId)
Gets the
Repository Ids mapped to a
Composition. |
void |
useComparativeCompositionRepositoryView()
The returns from the lookup methods may omit or translate elements
based on this session, such as authorization, and not result in an
error.
|
void |
usePlenaryCompositionRepositoryView()
A complete view of the
Composition and
Repository returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
void useComparativeCompositionRepositoryView()
mandatory
- This method is must be implemented. void usePlenaryCompositionRepositoryView()
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.mandatory
- This method is must be implemented. boolean canLookupCompositionRepositoryMappings()
PERMISSION_DENIED.
This is intended as a hint to an application that may opt not
to offer lookup operations to unauthorized users. false
if looking up mappings is not authorized,
true
otherwisemandatory
- This method must be implemented. IdList getCompositionIdsByRepository(Id repositoryId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Composition
Ids
associated with a Repository.
repositoryId
- Id
of the Repository
Ids
NotFoundException
- repositoryId
is not
foundNullArgumentException
- repositoryId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. CompositionList getCompositionsByRepository(Id repositoryId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Compositions
associated with a
Repository.
repositoryId
- Id
of the Repository
NotFoundException
- repositoryId
is not
foundNullArgumentException
- repositoryId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IdList getCompositionIdsByRepositories(IdList repositoryIds) throws OperationFailedException, PermissionDeniedException
Composition
Ids
corresponding to a list of Repository
objectsrepositoryIds
- list of repository Ids
Ids
NullArgumentException
- repositoryIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. CompositionList getCompoitionsByRepositories(IdList repositoryIds) throws OperationFailedException, PermissionDeniedException
Compositions
corresponding to a list
of Repository
objectsrepositoryIds
- list of repository Ids
NullArgumentException
- repositoryIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IdList getRepositoryIdsByComposition(Id compositionId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Repository
Ids
mapped to a
Composition.
compositionId
- Id
of a Composition
Ids
NotFoundException
- compositionId
is not
foundNullArgumentException
- compositionId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. RepositoryList getRepositoriesByComposition(Id compositionId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Repository
objects mapped to a
Composition.
compositionId
- Id
of a Composition
NotFoundException
- compositionId
is not
foundNullArgumentException
- compositionId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.