public interface CommitmentEnablerLookupSession extends OsidSession
This session provides methods for retrieving CommitmentEnablers.
This session defines views that offer differing behaviors when retrieving multiple objects.
CommitmentEnablers
with the
CommitmentEnablerAdminSession.
Generally, the comparative view should be used for most applications
as it permits operation even if there is data that cannot be accessed. The
methods useFederatedDistributorView()
and
useIsolatedDistributorView()
behave as a radio group and one
should be selected before invoking the methods in this session.
Modifier and Type | Method and Description |
---|---|
boolean |
canLookupCommitmentEnablers()
Tests if this user can perform
CommitmentEnablers
lookups. |
Calendar |
getCalendar()
Gets the
Calendar associated with this session. |
Id |
getCalendarId()
Gets the
Calendar Id associated with
this session. |
CommitmentEnabler |
getCommitmentEnabler(Id commitmentEnablerId)
Gets the
CommitmentEnabler specified by its Id. |
CommitmentEnablerList |
getCommitmentEnablers()
Gets all
CommitmentEnablers. |
CommitmentEnablerList |
getCommitmentEnablersByGenusType(Type commitmentEnablerGenusType)
Gets a
CommitmentEnablerList corresponding to the given
commitment enabler genus Type which does not include
commitment enablers of genus types derived from the specified
Type. |
CommitmentEnablerList |
getCommitmentEnablersByIds(IdList commitmentEnablerIds)
Gets a
CommitmentEnablerList corresponding to the given
IdList. |
CommitmentEnablerList |
getCommitmentEnablersByParentGenusType(Type commitmentEnablerGenusType)
Gets a
CommitmentEnablerList corresponding to the given
commitment enabler genus Type and include any
additional commitment enablers with genus types derived from the
specified Type. |
CommitmentEnablerList |
getCommitmentEnablersByRecordType(Type commitmentEnablerRecordType)
Gets a
CommitmentEnablerList containing the given
commitment enabler record Type. |
CommitmentEnablerList |
getCommitmentEnablersOnDate(DateTime from,
DateTime to)
Gets a
CommitmentEnablerList effective during the
entire given date range inclusive but not confined to the date range
for any agent. |
CommitmentEnablerList |
getCommitmentEnablersOnDateWithAgent(Id agentId,
DateTime from,
DateTime to)
Gets a
CommitmentEnablerList effective during the
entire given date range inclusive but not confined to the date range
evaluated against the given agent. |
void |
useActiveCommitmentEnablerView()
Only active commitment enablers are returned by methods in this
session.
|
void |
useAnyStatusCommitmentEnablerView()
All active and inactive commitment enablers are returned by methods in
this session.
|
void |
useComparativeCommitmentEnablerView()
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 |
useFederatedCalendarView()
Federates the view for methods in this session.
|
void |
useIsolatedCalendarView()
Isolates the view for methods in this session.
|
void |
usePlenaryCommitmentEnablerView()
A complete view of the
CommitmentEnabler returns is
desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getCalendarId()
Calendar
Id
associated with
this session. Calendar Id
associated with this sessionmandatory
- This method must be implemented. Calendar getCalendar() throws OperationFailedException, PermissionDeniedException
Calendar
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canLookupCommitmentEnablers()
CommitmentEnablers
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 useComparativeCommitmentEnablerView()
mandatory
- This method is must be implemented. void usePlenaryCommitmentEnablerView()
CommitmentEnabler
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 useFederatedCalendarView()
mandatory
- This method is must be implemented. void useIsolatedCalendarView()
mandatory
- This method is must be implemented. void useActiveCommitmentEnablerView()
mandatory
- This method is must be implemented. void useAnyStatusCommitmentEnablerView()
mandatory
- This method is must be implemented. CommitmentEnabler getCommitmentEnabler(Id commitmentEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
CommitmentEnabler
specified by its Id.
In plenary mode, the exact Id
is found
or a NOT_FOUND
results. Otherwise, the returned
CommitmentEnabler
may have a different Id
than
requested, such as the case where a duplicate Id
was
assigned to a CommitmentEnabler
and retained for
compatibility.
In active mode, commitment enablers are returned that are currently
active. In any status mode, active and inactive commitment enablers
are returned.commitmentEnablerId
- Id
of the
CommitmentEnabler
NotFoundException
- commitmentEnablerId
not foundNullArgumentException
- commitmentEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method is must be implemented. CommitmentEnablerList getCommitmentEnablersByIds(IdList commitmentEnablerIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
CommitmentEnablerList
corresponding to the given
IdList.
In plenary mode, the returned list contains all of the
commitment 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 CommitmentEnablers
may be
omitted from the list and may present the elements in any order
including returning a unique set.
In active mode, commitment enablers are returned that are currently
active. In any status mode, active and inactive commitment enablers
are returned.commitmentEnablerIds
- the list of Ids
to
retrieve CommitmentEnabler
listNotFoundException
- an Id was
not foundNullArgumentException
- commitmentEnablerIds
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. CommitmentEnablerList getCommitmentEnablersByGenusType(Type commitmentEnablerGenusType) throws OperationFailedException, PermissionDeniedException
CommitmentEnablerList
corresponding to the given
commitment enabler genus Type
which does not include
commitment enablers of genus types derived from the specified
Type.
In plenary mode, the returned list contains all known
commitment enablers or an error results. Otherwise, the returned list
may contain only those commitment enablers that are accessible through
this session.
In active mode, commitment enablers are returned that are currently
active. In any status mode, active and inactive commitment enablers
are returned.commitmentEnablerGenusType
- a commitment enabler genus type CommitmentEnabler
listNullArgumentException
-
commitmentEnablerGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. CommitmentEnablerList getCommitmentEnablersByParentGenusType(Type commitmentEnablerGenusType) throws OperationFailedException, PermissionDeniedException
CommitmentEnablerList
corresponding to the given
commitment enabler genus Type
and include any
additional commitment enablers with genus types derived from the
specified Type.
In plenary mode, the returned list contains all known
commitment enablers or an error results. Otherwise, the returned list
may contain only those commitment enablers that are accessible through
this session.
In active mode, commitment enablers are returned that are currently
active. In any status mode, active and inactive commitment enablers
are returned.commitmentEnablerGenusType
- a commitment enabler genus type CommitmentEnabler
listNullArgumentException
-
commitmentEnablerGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. CommitmentEnablerList getCommitmentEnablersByRecordType(Type commitmentEnablerRecordType) throws OperationFailedException, PermissionDeniedException
CommitmentEnablerList
containing the given
commitment enabler record Type.
In plenary mode, the returned list contains all known
commitment enablers or an error results. Otherwise, the returned list
may contain only those commitment enablers that are accessible through
this session.
In effective mode, commitments are returned that are currently
effective. In any effective mode, effective commitments and those
currently expired are returned.commitmentEnablerRecordType
- a commitment enabler record type CommitmentEnabler
listNullArgumentException
-
commitmentEnablerRecordType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. CommitmentEnablerList getCommitmentEnablersOnDate(DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
CommitmentEnablerList
effective during 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
commitment enablers or an error results. Otherwise, the returned list
may contain only those commitment enablers that are accessible through
this session.
In active mode, commitment enablers are returned that are currently
active in addition to being effective during the given date range. In
any status mode, active and inactive commitment enablers are returned.from
- a start dateto
- an end date CommitmentEnabler
listInvalidArgumentException
- from
is
greater than to
NullArgumentException
- from
or
to
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. CommitmentEnablerList getCommitmentEnablersOnDateWithAgent(Id agentId, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
CommitmentEnablerList
effective during 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
commitment enablers or an error results. Otherwise, the returned list
may contain only those commitment enablers that are accessible through
this session.
In active mode, commitment enablers are returned that are currently
active in addition to being effective during the given date range. In
any status mode, active and inactive commitment enablers are returned.agentId
- an agent Idfrom
- a start dateto
- an end date CommitmentEnabler
listInvalidArgumentException
- from
is
greater than to
NullArgumentException
- agent, from,
or
to
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. CommitmentEnablerList getCommitmentEnablers() throws OperationFailedException, PermissionDeniedException
CommitmentEnablers.
In plenary mode, the returned list contains all known commitment
enablers or an error results. Otherwise, the returned list may contain
only those commitment enablers that are accessible through this
session.
In active mode, commitment enablers are returned that are currently
active. In any status mode, active and inactive commitment enablers
are returned. CommitmentEnabler
listOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.