public interface RecurringEventQuerySession extends OsidSession
This session provides methods for searching RecurringEvent
objects. The search query is constructed using the
RecurringEventQuery.
The recurring event record Type
also specifies the record for the recurring event query.
This session defines views that offer differing behaviors for searching.
RecurringEvents
may have a query record indicated by
their respective record types. The query ecord is accessed via the
RecurringEventQuery.
Modifier and Type | Method and Description |
---|---|
boolean |
canSearchRecurringEvents()
Tests if this user can perform
RecurringEvents
searches. |
Calendar |
getCalendar()
Gets the
Calendar associated with this session. |
Id |
getCalendarId()
Gets the
Calendar Id associated with
this session. |
RecurringEventQuery |
getRecurringEventQuery()
Gets a recurring event query.
|
RecurringEventList |
getRecurringEventsByQuery(RecurringEventQuery recurringEventQuery)
Gets a list of
RecurringEvents matching the given
recurring 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 canSearchRecurringEvents()
RecurringEvents
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. RecurringEventQuery getRecurringEventQuery()
mandatory
- This method must be implemented. RecurringEventList getRecurringEventsByQuery(RecurringEventQuery recurringEventQuery) throws OperationFailedException, PermissionDeniedException
RecurringEvents
matching the given
recurring event query.recurringEventQuery
- the recurring event query RecurringEventList
NullArgumentException
- recurringEventQuery
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- recurringEventQuery
is not of this servicemandatory
- This method must be implemented.