public interface OffsetEventQuerySession extends OsidSession
This session provides methods for searching OffsetEvent
objects. The search query is constructed using the
OffsetEventQuery.
The offset event record Type
also
specifies the record for the offset event query.
This session defines views that offer differing behaviors for searching.
OffsetEvents
may have a query record indicated by their
respective record types. The query record is accessed via the
OffsetEventQuery.
Modifier and Type | Method and Description |
---|---|
boolean |
canSearchOffsetEvents()
Tests if this user can perform
OffsetEvents searches. |
Calendar |
getCalendar()
Gets the
Calendar associated with this session. |
Id |
getCalendarId()
Gets the
Calendar Id associated with
this session. |
OffsetEventQuery |
getOffsetEventQuery()
Gets an offset event query.
|
OffsetEventList |
getOffsetEventsByQuery(OffsetEventQuery offsetEventQuery)
Gets a list of
OffsetEvents matching the given offset
event query. |
void |
useFederatedCalendarView()
Federates the view for methods in this session.
|
void |
useIsolatedCalendarView()
Isolates the view for methods in this session.
|
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 canSearchOffsetEvents()
OffsetEvents
searches. 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 search operations to
unauthorized users. false
if search methods are not authorized,
true
otherwisemandatory
- This method must be implemented. void useFederatedCalendarView()
mandatory
- This method is must be implemented. void useIsolatedCalendarView()
mandatory
- This method is must be implemented. OffsetEventQuery getOffsetEventQuery()
mandatory
- This method must be implemented. OffsetEventList getOffsetEventsByQuery(OffsetEventQuery offsetEventQuery) throws OperationFailedException, PermissionDeniedException
OffsetEvents
matching the given offset
event query.offsetEventQuery
- the offset event query OffsetEventList
NullArgumentException
- offsetEventQuery
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- offsetEventQuery
is not of this servicemandatory
- This method must be implemented.