public interface SupersedingEventEnablerLookupSession extends OsidSession
This session provides methods for retrieving
SupersedingEventEnablers.
This session defines views that offer differing behaviors when retrieving multiple objects.
SupersedingEventEnablers
with the SupersedingEventEnablerAdminSession.
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 |
canLookupSupersedingEventEnablers()
Tests if this user can perform
SupersedingEventEnablers
lookups. |
Calendar |
getCalendar()
Gets the
Calendar associated with this session. |
Id |
getCalendarId()
Gets the
Calendar Id associated with
this session. |
SupersedingEventEnabler |
getSupersedingEventEnabler(Id supersedingEventEnablerId)
Gets the
SupersedingEventEnabler specified by its
Id. |
SupersedingEventEnablerList |
getSupersedingEventEnablers()
Gets all
SupersedingEventEnablers. |
SupersedingEventEnablerList |
getSupersedingEventEnablersByGenusType(Type supersedingEventEnablerGenusType)
Gets a
SupersedingEventEnablerList corresponding to the
given superseding event enabler genus Type which does
not include superseding event enablers of genus types derived from the
specified Type. |
SupersedingEventEnablerList |
getSupersedingEventEnablersByIds(IdList supersedingEventEnablerIds)
Gets a
SupersedingEventEnablerList corresponding to the
given IdList. |
SupersedingEventEnablerList |
getSupersedingEventEnablersByParentGenusType(Type supersedingEventEnablerGenusType)
Gets a
SupersedingEventEnablerList corresponding to the
given superseding event enabler genus Type and include
any additional superseding event enablers with genus types derived
from the specified Type. |
SupersedingEventEnablerList |
getSupersedingEventEnablersByRecordType(Type supersedingEventEnablerRecordType)
Gets a
SupersedingEventEnablerList containing the given
superseding event enabler record Type. |
SupersedingEventEnablerList |
getSupersedingEventEnablersOnDate(DateTime from,
DateTime to)
Gets a
SupersedingEventEnablerList effectiveduring the
entire given date range inclusive but not confined to the date range. |
SupersedingEventEnablerList |
getSupersedingEventEnablersOnDateWithAgent(Id agentId,
DateTime from,
DateTime to)
Gets a
SupersedingEventEnablerList effectiveduring the
entire given date range inclusive but not confined to the date range
evaluated against the given agent. |
void |
useActiveSupersedingEventEnablerView()
Only active superseding event enablers are returned by methods in this
session.
|
void |
useAnyStatusSupersedingEventEnablerView()
All active and inactive superseding event enablers are returned by
methods in this session.
|
void |
useComparativeSupersedingEventEnablerView()
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 |
usePlenarySupersedingEventEnablerView()
A complete view of the
SupersedingEventEnabler 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 canLookupSupersedingEventEnablers()
SupersedingEventEnablers
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 useComparativeSupersedingEventEnablerView()
mandatory
- This method is must be implemented. void usePlenarySupersedingEventEnablerView()
SupersedingEventEnabler
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 useActiveSupersedingEventEnablerView()
mandatory
- This method is must be implemented. void useAnyStatusSupersedingEventEnablerView()
mandatory
- This method is must be implemented. SupersedingEventEnabler getSupersedingEventEnabler(Id supersedingEventEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
SupersedingEventEnabler
specified by its
Id.
In plenary mode, the exact Id
is found
or a NOT_FOUND
results. Otherwise, the returned
SupersedingEventEnabler
may have a different Id
than requested, such as the case where a duplicate Id
was assigned to a SupersedingEventEnabler
and retained
for compatibility.
In active mode, supseding event enablers are returned that are
currently active. In any status mode, active and inactive superseding
event enablers are returned.supersedingEventEnablerId
- Id
of the
SupersedingEventEnabler
NotFoundException
- supersedingEventEnablerId
not foundNullArgumentException
-
supersedingEventEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method is must be implemented. SupersedingEventEnablerList getSupersedingEventEnablersByIds(IdList supersedingEventEnablerIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
SupersedingEventEnablerList
corresponding to the
given IdList.
In plenary mode, the returned list contains all of the
superseding event 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 SupersedingEventEnablers
may be
omitted from the list and may present the elements in any order
including returning a unique set.
In active mode, supseding event enablers are returned that are
currently active. In any status mode, active and inactive superseding
event enablers are returned.supersedingEventEnablerIds
- the list of Ids
to
retrieve SupersedingEventEnabler
listNotFoundException
- an Id was
not foundNullArgumentException
-
supersedingEventEnablerIds
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. SupersedingEventEnablerList getSupersedingEventEnablersByGenusType(Type supersedingEventEnablerGenusType) throws OperationFailedException, PermissionDeniedException
SupersedingEventEnablerList
corresponding to the
given superseding event enabler genus Type
which does
not include superseding event enablers of genus types derived from the
specified Type.
In plenary mode, the returned list contains all known
superseding event enablers or an error results. Otherwise, the
returned list may contain only those superseding event enablers that
are accessible through this session.
In active mode, supseding event enablers are returned that are
currently active. In any status mode, active and inactive superseding
event enablers are returned.supersedingEventEnablerGenusType
- a superseding event enabler
genus type SupersedingEventEnabler
listNullArgumentException
-
supersedingEventEnablerGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. SupersedingEventEnablerList getSupersedingEventEnablersByParentGenusType(Type supersedingEventEnablerGenusType) throws OperationFailedException, PermissionDeniedException
SupersedingEventEnablerList
corresponding to the
given superseding event enabler genus Type
and include
any additional superseding event enablers with genus types derived
from the specified Type.
In plenary mode, the returned list contains all known
superseding event enablers or an error results. Otherwise, the
returned list may contain only those superseding event enablers that
are accessible through this session.
In active mode, supseding event enablers are returned that are
currently active. In any status mode, active and inactive superseding
event enablers are returned.supersedingEventEnablerGenusType
- a superseding event enabler
genus type SupersedingEventEnabler
listNullArgumentException
-
supersedingEventEnablerGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. SupersedingEventEnablerList getSupersedingEventEnablersByRecordType(Type supersedingEventEnablerRecordType) throws OperationFailedException, PermissionDeniedException
SupersedingEventEnablerList
containing the given
superseding event enabler record Type.
In plenary mode, the returned list contains all known
superseding event enablers or an error results. Otherwise, the
returned list may contain only those superseding event enablers that
are accessible through this session.
In active mode, supseding event enablers are returned that are
currently active. In any status mode, active and inactive superseding
event enablers are returned.supersedingEventEnablerRecordType
- a superseding event enabler
record type SupersedingEventEnabler
listNullArgumentException
-
supersedingEventEnablerRecordType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. SupersedingEventEnablerList getSupersedingEventEnablersOnDate(DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
SupersedingEventEnablerList
effectiveduring the
entire given date range inclusive but not confined to the date range.
In plenary mode, the returned list contains all known
superseding event enablers or an error results. Otherwise, the
returned list may contain only those superseding event enablers that
are accessible through this session.
In active mode, supseding event enablers are returned that are
currently active in addition to being effective during the given date
range. In any status mode, active and inactive superseding event
enablers are returned.from
- a start dateto
- an end date SupersedingEventEnabler
listInvalidArgumentException
- from
is
greater than to
NullArgumentException
- from
or
to
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. SupersedingEventEnablerList getSupersedingEventEnablersOnDateWithAgent(Id agentId, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
SupersedingEventEnablerList
effectiveduring 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
superseding event enablers or an error results. Otherwise, the
returned list may contain only those superseding event enablers that
are accessible through this session.
In active mode, supseding event enablers are returned that are
currently active in addition to being effective during the given date
range. In any status mode, active and inactive superseding event
enablers are returned.agentId
- an agent Idfrom
- a start dateto
- an end date SupersedingEventEnabler
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. SupersedingEventEnablerList getSupersedingEventEnablers() throws OperationFailedException, PermissionDeniedException
SupersedingEventEnablers.
In plenary mode, the returned list contains all known superseding
event enablers or an error results. Otherwise, the returned list may
contain only those superseding event enablers that are accessible
through this session.
In active mode, supseding event enablers are returned that are
currently active. In any status mode, active and inactive superseding
event enablers are returned. SupersedingEventEnabler
listOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.