public interface OffsetEventEnablerLookupSession extends OsidSession
This session provides methods for retrieving
OffsetEventEnablers.
This session defines views that offer differing behaviors when retrieving multiple objects.
OffsetEventEnablers
with the
OffsetEventEnablerAdminSession.
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 |
canLookupOffsetEventEnablers()
Tests if this user can perform
OffsetEventEnablers
lookups. |
Calendar |
getCalendar()
Gets the
Calendar associated with this session. |
Id |
getCalendarId()
Gets the
Calendar Id associated with
this session. |
OffsetEventEnabler |
getOffsetEventEnabler(Id offsetEventEnablerId)
Gets the
OffsetEventEnabler specified by its Id. |
OffsetEventEnablerList |
getOffsetEventEnablers()
Gets all
OffsetEventEnablers. |
OffsetEventEnablerList |
getOffsetEventEnablersByGenusType(Type offsetEventEnablerGenusType)
Gets an
OffsetEventEnablerList corresponding to the
given offset event enabler genus Type which does not
include offset event enablers of genus types derived from the
specified Type. |
OffsetEventEnablerList |
getOffsetEventEnablersByIds(IdList offsetEventEnablerIds)
Gets an
OffsetEventEnablerList corresponding to the
given IdList. |
OffsetEventEnablerList |
getOffsetEventEnablersByParentGenusType(Type offsetEventEnablerGenusType)
Gets an
OffsetEventEnablerList corresponding to the
given offset event enabler genus Type and include any
additional offset event enablers with genus types derived from the
specified Type. |
OffsetEventEnablerList |
getOffsetEventEnablersByRecordType(Type offsetEventEnablerRecordType)
Gets an
OffsetEventEnablerList containing the given
offset event enabler record Type. |
OffsetEventEnablerList |
getOffsetEventEnablersOnDate(DateTime from,
DateTime to)
Gets an
OffsetEventEnablerList effective for the entire
the given date range inclusive but not confisned to the date range for
any agent. |
OffsetEventEnablerList |
getOffsetEventEnablersOnDateWithAgent(Id agentId,
DateTime from,
DateTime to)
Gets an
OffsetEventEnablerList effective for the entire
the given date range. |
void |
useActiveOffsetEventEnablerView()
Only active offset event enablers are returned by methods in this
session.
|
void |
useAnyStatusOffsetEventEnablerView()
All active and inactive offset event enablers are returned by methods
in this session.
|
void |
useComparativeOffsetEventEnablerView()
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 |
usePlenaryOffsetEventEnablerView()
A complete view of the
OffsetEventEnabler 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 canLookupOffsetEventEnablers()
OffsetEventEnablers
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 useComparativeOffsetEventEnablerView()
mandatory
- This method is must be implemented. void usePlenaryOffsetEventEnablerView()
OffsetEventEnabler
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 useActiveOffsetEventEnablerView()
mandatory
- This method is must be implemented. void useAnyStatusOffsetEventEnablerView()
mandatory
- This method is must be implemented. OffsetEventEnabler getOffsetEventEnabler(Id offsetEventEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
OffsetEventEnabler
specified by its Id.
In plenary mode, the exact Id
is found
or a NOT_FOUND
results. Otherwise, the returned
OffsetEventEnabler
may have a different Id
than
requested, such as the case where a duplicate Id
was
assigned to an OffsetEventEnabler
and retained for
compatibility.
In active mode, offset event enablers are returned that are currently
active. In any status mode, active and inactive offset event enablers
are returned.offsetEventEnablerId
- Id
of the
OffsetEventEnabler
NotFoundException
- offsetEventEnablerId
not foundNullArgumentException
- offsetEventEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method is must be implemented. OffsetEventEnablerList getOffsetEventEnablersByIds(IdList offsetEventEnablerIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
OffsetEventEnablerList
corresponding to the
given IdList.
In plenary mode, the returned list contains all of the
offset 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 OffsetEventEnablers
may be
omitted from the list and may present the elements in any order
including returning a unique set.
In active mode, offset event enablers are returned that are currently
active. In any status mode, active and inactive offset event enablers
are returned.offsetEventEnablerIds
- the list of Ids
to
retrieve OffsetEventEnabler
listNotFoundException
- an Id was
not foundNullArgumentException
- offsetEventEnablerIds
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. OffsetEventEnablerList getOffsetEventEnablersByGenusType(Type offsetEventEnablerGenusType) throws OperationFailedException, PermissionDeniedException
OffsetEventEnablerList
corresponding to the
given offset event enabler genus Type
which does not
include offset event enablers of genus types derived from the
specified Type.
In plenary mode, the returned list contains all known
offset event enablers or an error results. Otherwise, the returned
list may contain only those offset event enablers that are accessible
through this session.
In active mode, offset event enablers are returned that are currently
active. In any status mode, active and inactive offset event enablers
are returned.offsetEventEnablerGenusType
- an offset event enabler genus type OffsetEventEnabler
listNullArgumentException
-
offsetEventEnablerGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. OffsetEventEnablerList getOffsetEventEnablersByParentGenusType(Type offsetEventEnablerGenusType) throws OperationFailedException, PermissionDeniedException
OffsetEventEnablerList
corresponding to the
given offset event enabler genus Type
and include any
additional offset event enablers with genus types derived from the
specified Type.
In plenary mode, the returned list contains all known
offset event enablers or an error results. Otherwise, the returned
list may contain only those offset event enablers that are accessible
through this session.
In active mode, offset event enablers are returned that are currently
active. In any status mode, active and inactive offset event enablers
are returned.offsetEventEnablerGenusType
- an offset event enabler genus type OffsetEventEnabler
listNullArgumentException
-
offsetEventEnablerGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. OffsetEventEnablerList getOffsetEventEnablersByRecordType(Type offsetEventEnablerRecordType) throws OperationFailedException, PermissionDeniedException
OffsetEventEnablerList
containing the given
offset event enabler record Type.
In plenary mode, the returned list contains all known
offset event enablers or an error results. Otherwise, the returned
list may contain only those offset event enablers that are accessible
through this session.
In active mode, offset event enablers are returned that are currently
active. In any status mode, active and inactive offset event enablers
are returned.offsetEventEnablerRecordType
- an offset event enabler record
type OffsetEventEnabler
listNullArgumentException
-
ofsetEventEnablerRecordType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. OffsetEventEnablerList getOffsetEventEnablersOnDate(DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
OffsetEventEnablerList
effective for the entire
the given date range inclusive but not confisned to the date range for
any agent.
In plenary mode, the returned list contains all known
offset event enablers or an error results. Otherwise, the returned
list may contain only those offset event enablers that are accessible
through this session.
In active mode, offset 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 offset event enablers are
returned.from
- a start dateto
- an end date OffsetEventEnabler
listInvalidArgumentException
- from
is
greater than to
NullArgumentException
- from
or
to
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. OffsetEventEnablerList getOffsetEventEnablersOnDateWithAgent(Id agentId, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
OffsetEventEnablerList
effective for the entire
the given date range. inclusive but not confisned to the date range
and evaluated against the given agent.
In plenary mode, the returned list contains all known
offset event enablers or an error results. Otherwise, the returned
list may contain only those offset event enablers that are accessible
through this session.
In active mode, offset event enablers are returned that are currently
active. In any status mode, active and inactive offset event enablers
are returned.agentId
- an agent Idfrom
- a start dateto
- an end date OffsetEventEnabler
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. OffsetEventEnablerList getOffsetEventEnablers() throws OperationFailedException, PermissionDeniedException
OffsetEventEnablers.
In plenary mode, the returned list contains all known offset event
enablers or an error results. Otherwise, the returned list may contain
only those offset event enablers that are accessible through this
session.
In active mode, offset event enablers are returned that are currently
active. In any status mode, active and inactive offset event enablers
are returned. OffsetEventEnabler
listOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.