public interface CompositionEnablerRepositorySession extends OsidSession
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:
Modifier and Type | Method and Description |
---|---|
boolean |
canLookupCompositionEnablerRepositorytMappings()
Tests if this user can perform lookups of composition
enabler/repository mappings.
|
IdList |
getCompositionEnablerIdsByRepositories(IdList repositoryIds)
Gets the list of
CompositionEnabler Ids corresponding
to a list of Repositories. |
IdList |
getCompositionEnablerIdsByRepository(Id repositoryId)
Gets the list of
CompositionEnablerIds associated with
a Repository. |
CompositionEnablerList |
getCompositionEnablersByRepositories(IdList repositoryIds)
Gets the list of composition enablers corresponding to a list of
Repositories. |
CompositionEnablerList |
getCompositionEnablersByRepository(Id repositoryId)
Gets the list of composition enablers associated with a
Repository. |
RepositoryList |
getCompositionsByCompositionEnabler(Id compositionEnablerId)
Gets the repositories mapped to a
CompositionEnabler. |
IdList |
getRepositoryIdsByCompositionEnabler(Id compositionEnablerId)
Gets the
Repository Ids mapped to a
CompositionEnabler. |
void |
useComparativeCompositionEnablerRepositoryView()
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 |
usePlenaryCompositionEnablerRepositoryView()
A complete view of the
CompositionEnabler and
Repository returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canLookupCompositionEnablerRepositorytMappings()
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. void useComparativeCompositionEnablerRepositoryView()
mandatory
- This method is must be implemented. void usePlenaryCompositionEnablerRepositoryView()
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.mandatory
- This method is must be implemented. IdList getCompositionEnablerIdsByRepository(Id repositoryId) throws NotFoundException, OperationFailedException, PermissionDeniedException
CompositionEnablerIds
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. CompositionEnablerList getCompositionEnablersByRepository(Id repositoryId) throws NotFoundException, OperationFailedException, PermissionDeniedException
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 getCompositionEnablerIdsByRepositories(IdList repositoryIds) throws OperationFailedException, PermissionDeniedException
CompositionEnabler Ids
corresponding
to a list of Repositories.
repositoryIds
- list of repository Ids
Ids
NullArgumentException
- familtIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. CompositionEnablerList getCompositionEnablersByRepositories(IdList repositoryIds) throws OperationFailedException, PermissionDeniedException
Repositories.
repositoryIds
- list of repository Ids
NullArgumentException
- repositoryIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IdList getRepositoryIdsByCompositionEnabler(Id compositionEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Repository
Ids
mapped to a
CompositionEnabler.
compositionEnablerId
- Id
of a
CompositionEnabler
Ids
NotFoundException
- compositionEnablerId
is not foundNullArgumentException
- compositionEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. RepositoryList getCompositionsByCompositionEnabler(Id compositionEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
CompositionEnabler.
compositionEnablerId
- Id
of a
CompositionEnabler
NotFoundException
- compositionEnablerId
is not foundNullArgumentException
- compositionEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.