public interface OffsetEventLookupSession extends OsidSession
This session provides methods for retrieving OffsetEvents.
This session defines views that offer differing behaviors when retrieving multiple objects.
OffsetEventAdminSession.
Modifier and Type | Method and Description |
---|---|
boolean |
canLookupOffsetEvents()
Tests if this user can perform
OffsetEvent lookups. |
Calendar |
getCalendar()
Gets the
Calendar associated with this session. |
Id |
getCalendarId()
Gets the
Calendar Id associated with
this session. |
OffsetEvent |
getOffsetEvent(Id offsetEventId)
Gets the
OffsetEvent specified by its Id. |
OffsetEventList |
getOffsetEvents()
Gets all
OffsetEvents. |
OffsetEventList |
getOffsetEventsByEvent(Id eventId)
Gets the
OffsetEvents using the given event as a start
or ending offset. |
OffsetEventList |
getOffsetEventsByGenusType(Type offsetEventGenusType)
Gets an
OffsetEventList corresponding to the given
offset event genus Type which does not include offset
events of genus types derived from the specified Type. |
OffsetEventList |
getOffsetEventsByIds(IdList offsetEventIds)
Gets an
OffsetEventList corresponding to the given
IdList. |
OffsetEventList |
getOffsetEventsByParentGenusType(Type offsetEventGenusType)
Gets an
OffsetEventList corresponding to the given
offset event genus Type and include any additional
offset event with genus types derived from the specified Type. |
OffsetEventList |
getOffsetEventsByRecordType(Type offsetEventrecordType)
Gets an
OffsetEventList containing the given offset
event record Type. |
void |
useActiveOffsetEventView()
Only active offset events are returned by methods in this session.
|
void |
useAnyStatusOffsetEventView()
All active and inactive offset events are returned by methods in this
session.
|
void |
useComparativeOffsetEventView()
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 |
usePlenaryOffsetEventView()
A complete view of the
OffsetEvent 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. Calendar
associated with this sessionOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canLookupOffsetEvents()
OffsetEvent
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 useComparativeOffsetEventView()
mandatory
- This method is must be implemented. void usePlenaryOffsetEventView()
OffsetEvent
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 useActiveOffsetEventView()
mandatory
- This method is must be implemented. void useAnyStatusOffsetEventView()
mandatory
- This method is must be implemented. OffsetEvent getOffsetEvent(Id offsetEventId) throws NotFoundException, OperationFailedException, PermissionDeniedException
OffsetEvent
specified by its Id.
In plenary mode, the exact Id
is found
or a NOT_FOUND
results. Otherwise, the returned
OffsetEvent
may have a different Id
than
requested, such as the case where a duplicate Id
was
assigned to an OffsetEvent
and retained for
compatibility.
In active mode, offset events are returned that are currently active.
In any status mode, active and inactive offset events are returned.offsetEventId
- Id
of the OffsetEvent
NotFoundException
- offsetEventId
not
foundNullArgumentException
- offsetEventId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method is must be implemented. OffsetEventList getOffsetEventsByIds(IdList offsetEventIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
OffsetEventList
corresponding to the given
IdList.
In plenary mode, the returned list contains all of the
offset events 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 OffsetEvents
may be omitted from the list
and may present the elements in any order including returning a unique
set.
In active mode, offset events are returned that are currently active.
In any status mode, active and inactive offset events are returned.offsetEventIds
- the list of Ids
to retrieve OffsetEvent
listNotFoundException
- an Id was
not foundNullArgumentException
- offsetEventIds
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. OffsetEventList getOffsetEventsByGenusType(Type offsetEventGenusType) throws OperationFailedException, PermissionDeniedException
OffsetEventList
corresponding to the given
offset event genus Type
which does not include offset
events of genus types derived from the specified Type.
In plenary mode, the returned list contains all known
offset events or an error results. Otherwise, the returned list may
contain only those offset events that are accessible through this
session.
In active mode, offset events are returned that are currently active.
In any status mode, active and inactive offset events are returned.offsetEventGenusType
- an offset event genus type OffsetEvent
listNullArgumentException
- offsetEventGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. OffsetEventList getOffsetEventsByParentGenusType(Type offsetEventGenusType) throws OperationFailedException, PermissionDeniedException
OffsetEventList
corresponding to the given
offset event genus Type
and include any additional
offset event with genus types derived from the specified Type.
In plenary mode, the returned list contains all known
offset events or an error results. Otherwise, the returned list may
contain only those offset events that are accessible through this
session.
In active mode, offset events are returned that are currently active.
In any status mode, active and inactive offset events are returned.offsetEventGenusType
- an offset event genus type OffsetEvent
listNullArgumentException
- offsetEventGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. OffsetEventList getOffsetEventsByRecordType(Type offsetEventrecordType) throws OperationFailedException, PermissionDeniedException
OffsetEventList
containing the given offset
event record Type.
In plenary mode, the returned list contains all known
offset events or an error results. Otherwise, the returned list may
contain only those offset events that are accessible through this
session.
In active mode, offset events are returned that are currently active.
In any status mode, active and inactive offset events are returned.offsetEventrecordType
- an offset event record type OffsetEvent
listNullArgumentException
- offsetEventRecordType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. OffsetEventList getOffsetEventsByEvent(Id eventId) throws OperationFailedException, PermissionDeniedException
OffsetEvents
using the given event as a start
or ending offset.
In plenary mode, the returned list contains all known offset events or
an error results. Otherwise, the returned list may contain only those
offset events that are accessible through this session.
In active mode, offset events are returned that are currently active.
In any status mode, active and inactive offset events are returned.eventId
- Id
of the related eventNullArgumentException
- eventId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method is must be implemented. OffsetEventList getOffsetEvents() throws OperationFailedException, PermissionDeniedException
OffsetEvents.
In plenary mode, the returned list contains all known offset events or
an error results. Otherwise, the returned list may contain only those
offset events that are accessible through this session.
In active mode, offset events are returned that are currently active.
In any status mode, active and inactive offset events are returned. OffsetEventList
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.