public interface CompositionEnablerRuleLookupSession extends OsidSession
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:
Modifier and Type | Method and Description |
---|---|
boolean |
canLookupCompositionEnablerRules()
Tests if this user can perform lookups of composition
enabler/composition mappings.
|
IdList |
getCompositionEnablerIdsForComposition(Id compositionId)
Gets the
CompositionEnabler Id associated with a
Composition. |
CompositionEnablerList |
getCompositionEnablersForComposition(Id compositionId)
Gets the
CompositionEnabler associated with a
Composition. |
IdList |
getCompositionIdsByCompositionEnabler(Id compositionEnablerId)
Gets the
Composition Ids mapped to a
CompositionEnabler. |
CompositionList |
getCompositionsByCompositionEnabler(Id compositionEnablerId)
Gets the
Compositions mapped to a
CompositionEnabler. |
Repository |
getRepository()
Gets the
Repository associated with this session. |
Id |
getRepositoryId()
Gets the
Repository Id associated with
this session. |
void |
useComparativeCompositionEnablerRuleView()
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 |
useFederatedRepositoryView()
Federates the view for methods in this session.
|
void |
useIsolatedRepositoryView()
Isolates the view for methods in this session.
|
void |
usePlenaryCompositionEnablerRuleView()
A complete view of the
CompositionEnabler and
Composition returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getRepositoryId()
Repository
Id
associated with
this session. Repository Id
associated with this sessionmandatory
- This method must be implemented. Repository getRepository() throws OperationFailedException, PermissionDeniedException
Repository
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canLookupCompositionEnablerRules()
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 useComparativeCompositionEnablerRuleView()
mandatory
- This method is must be implemented. void usePlenaryCompositionEnablerRuleView()
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.mandatory
- This method is must be implemented. void useFederatedRepositoryView()
mandatory
- This method is must be implemented. void useIsolatedRepositoryView()
mandatory
- This method is must be implemented. IdList getCompositionEnablerIdsForComposition(Id compositionId) throws NotFoundException, OperationFailedException, PermissionDeniedException
CompositionEnabler Id
associated with a
Composition.
compositionId
- Id
of the Composition
Ids
NotFoundException
- compositionId
is not
foundNullArgumentException
- compositionId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. CompositionEnablerList getCompositionEnablersForComposition(Id compositionId) throws NotFoundException, OperationFailedException, PermissionDeniedException
CompositionEnabler
associated with a
Composition.
compositionId
- Id
of the Composition
NotFoundException
- compositionId
is not
foundNullArgumentException
- compositionId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IdList getCompositionIdsByCompositionEnabler(Id compositionEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Composition
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. CompositionList getCompositionsByCompositionEnabler(Id compositionEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Compositions
mapped to a
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.