public interface CompositionEnablerLookupSession extends OsidSession
This session provides methods for retrieving
CompositionEnablers.
This session defines views that offer differing behaviors when retrieving multiple objects.
CompositionEnablers
with the
CompositionEnablerAdminSession.
Modifier and Type | Method and Description |
---|---|
boolean |
canLookupCompositionEnablers()
Tests if this user can perform
CompositionEnablers
lookups. |
CompositionEnabler |
getCompositionEnabler(Id compositionEnablerId)
Gets the
CompositionEnabler specified by its Id. |
CompositionEnablerList |
getCompositionEnablers()
Gets all
CompositionEnablers. |
CompositionEnablerList |
getCompositionEnablersByGenusType(Type compositionEnablerGenusType)
Gets a
CompositionEnablerList corresponding to the
given composition enabler genus Type which does not
include composition enablers of genus types derived from the specified
Type. |
CompositionEnablerList |
getCompositionEnablersByIds(IdList compositionEnablerIds)
Gets a
CompositionEnablerList corresponding to the
given IdList. |
CompositionEnablerList |
getCompositionEnablersByParentGenusType(Type compositionEnablerGenusType)
Gets a
CompositionEnablerList corresponding to the
given composition enabler genus Type and include any
additional composition enablers with genus types derived from the
specified Type. |
CompositionEnablerList |
getCompositionEnablersByRecordType(Type compositionEnablerRecordType)
Gets a
CompositionEnablerList containing the given
composition enabler record Type. |
CompositionEnablerList |
getCompositionEnablersOnDate(DateTime from,
DateTime to)
Gets a
CompositionEnablerList that are effective for
the entire given date range inclusive but not confined to the date
range for any agent. |
CompositionEnablerList |
getCompositionEnablersOnDateWithAgent(Id agentId,
DateTime from,
DateTime to)
Gets a
CompositionEnablerList that are effective for
the entire given date range inclusive but not confined to the date
range evaluated against the given agent. |
Repository |
getRepository()
Gets the
Repository associated with this session. |
Id |
getRepositoryId()
Gets the
Repository Id associated with
this session. |
void |
useActiveCompositionEnablerView()
Only active composition enablers are returned by methods in this
session.
|
void |
useAnyStatusCompositionEnablerView()
All active and inactive composition enablers are returned by methods
in this session.
|
void |
useComparativeCompositionEnablerView()
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 |
usePlenaryCompositionEnablerView()
A complete view of the
CompositionEnabler 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 canLookupCompositionEnablers()
CompositionEnablers
lookups. A return of true does not guarantee successful authorization.
A return of false indicates that it is known all 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. false
if lookup methods are not authorized,
true
otherwisemandatory
- This method must be implemented. void useComparativeCompositionEnablerView()
mandatory
- This method is must be implemented. void usePlenaryCompositionEnablerView()
CompositionEnabler
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. void useActiveCompositionEnablerView()
mandatory
- This method is must be implemented. void useAnyStatusCompositionEnablerView()
mandatory
- This method is must be implemented. CompositionEnabler getCompositionEnabler(Id compositionEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
CompositionEnabler
specified by its Id.
In plenary mode, the exact Id
is found
or a NOT_FOUND
results. Otherwise, the returned
CompositionEnabler
may have a different Id
than
requested, such as the case where a duplicate Id
was
assigned to a CompositionEnabler
and retained for
compatibility.
In active mode, composition enablers are returned that are currently
active in addition to being effective during the given date range. In
any status mode, active and inactive composition enablers are
returned.compositionEnablerId
- Id
of the
CompositionEnabler
NotFoundException
- compositionEnablerId
not foundNullArgumentException
- compositionEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method is must be implemented. CompositionEnablerList getCompositionEnablersByIds(IdList compositionEnablerIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
CompositionEnablerList
corresponding to the
given IdList.
In plenary mode, the returned list contains all of the
composition enablers specified in the Id
list, in the
order of the list, including duplicates, or an error results if an
Id
in the supplied list is not found or inaccessible.
Otherwise, inaccessible CompositionEnablers
may be
omitted from the list and may present the elements in any order
including returning a unique set.
In active mode, composition enablers are returned that are currently
active in addition to being effective during the given date range. In
any status mode, active and inactive composition enablers are
returned.compositionEnablerIds
- the list of Ids
to
retrieve CompositionEnabler
listNotFoundException
- an Id was
not foundNullArgumentException
- compositionEnablerIds
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. CompositionEnablerList getCompositionEnablersByGenusType(Type compositionEnablerGenusType) throws OperationFailedException, PermissionDeniedException
CompositionEnablerList
corresponding to the
given composition enabler genus Type
which does not
include composition enablers of genus types derived from the specified
Type.
In plenary mode, the returned list contains all known
composition enablers or an error results. Otherwise, the returned list
may contain only those composition enablers that are accessible
through this session.
In active mode, composition enablers are returned that are currently
active in addition to being effective during the given date range. In
any status mode, active and inactive composition enablers are
returned.compositionEnablerGenusType
- a composition enabler genus type CompositionEnabler
listNullArgumentException
-
compositionEnablerGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. CompositionEnablerList getCompositionEnablersByParentGenusType(Type compositionEnablerGenusType) throws OperationFailedException, PermissionDeniedException
CompositionEnablerList
corresponding to the
given composition enabler genus Type
and include any
additional composition enablers with genus types derived from the
specified Type.
In plenary mode, the returned list contains all known
composition enablers or an error results. Otherwise, the returned list
may contain only those composition enablers that are accessible
through this session.
In active mode, composition enablers are returned that are currently
active in addition to being effective during the given date range. In
any status mode, active and inactive composition enablers are
returned.compositionEnablerGenusType
- a composition enabler genus type CompositionEnabler
listNullArgumentException
-
compositionEnablerGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. CompositionEnablerList getCompositionEnablersByRecordType(Type compositionEnablerRecordType) throws OperationFailedException, PermissionDeniedException
CompositionEnablerList
containing the given
composition enabler record Type.
In plenary mode, the returned list contains all known
composition enablers or an error results. Otherwise, the returned list
may contain only those composition enablers that are accessible
through this session.
In active mode, composition enablers are returned that are currently
active in addition to being effective during the given date range. In
any status mode, active and inactive composition enablers are
returned.compositionEnablerRecordType
- a composition enabler record type CompositionEnabler
listNullArgumentException
-
compositionEnablerRecordType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. CompositionEnablerList getCompositionEnablersOnDate(DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
CompositionEnablerList
that are effective for
the entire given date range inclusive but not confined to the date
range for any agent.
In plenary mode, the returned list contains all known
composition enablers or an error results. Otherwise, the returned list
may contain only those composition enablers that are accessible
through this session.
In active mode, composition enablers are returned that are currently
active in addition to being effective during the given date range. In
any status mode, active and inactive composition enablers are
returned.from
- a start dateto
- an end date CompositionEnabler
listInvalidArgumentException
- from
is
greater than to
NullArgumentException
- from
or
to
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. CompositionEnablerList getCompositionEnablersOnDateWithAgent(Id agentId, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
CompositionEnablerList
that are effective for
the entire given date range inclusive but not confined to the date
range evaluated against the given agent.
In plenary mode, the returned list contains all known
composition enablers or an error results. Otherwise, the returned list
may contain only those composition enablers that are accessible
through this session.
In active mode, composition enablers are returned that are currently
active in addition to being effective during the given date range. In
any status mode, active and inactive composition enablers are
returned.agentId
- an agent Id
from
- a start dateto
- an end date CompositionEnabler
listInvalidArgumentException
- from
is
greater than to
NullArgumentException
- agentId, from,
or to
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. CompositionEnablerList getCompositionEnablers() throws OperationFailedException, PermissionDeniedException
CompositionEnablers.
In plenary mode, the returned list contains all known composition
enablers or an error results. Otherwise, the returned list may contain
only those composition enablers that are accessible through this
session.
In active mode, composition enablers are returned that are currently
active in addition to being effective during the given date range. In
any status mode, active and inactive composition enablers are
returned. CompositionEnabler
listOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.