public interface RecurringEventEnablerQuerySession extends OsidSession
This session provides methods for searching among
RecurringEventEnabler
objects. The search query is constructed
using the RecurringEventEnablerQuery.
This session defines views that offer differing behaviors for searching.
Recurring event enablers may have a query record indicated by their
respective record types. The query record is accessed via the
RecurringEventEnablerQuery.
Modifier and Type | Method and Description |
---|---|
boolean |
canSearchRecurringEventEnablers()
Tests if this user can perform
RecurringEventEnabler
lookups. |
Calendar |
getCalendar()
Gets the
Calendar associated with this session. |
Id |
getCalendarId()
Gets the
Calendar Id associated with
this session. |
RecurringEventEnablerQuery |
getRecurringEventEnablerQuery()
Gets a recurring event enabler query.
|
RecurringEventEnablerList |
getRecurringEventEnablersByQuery(RecurringEventEnablerQuery recurringEventEnablerQuery)
Gets a list of
RecurringEventEnablers matching the
given recurring event enabler 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.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canSearchRecurringEventEnablers()
RecurringEventEnabler
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 not offer lookup
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. RecurringEventEnablerQuery getRecurringEventEnablerQuery()
mandatory
- This method must be implemented. RecurringEventEnablerList getRecurringEventEnablersByQuery(RecurringEventEnablerQuery recurringEventEnablerQuery) throws OperationFailedException, PermissionDeniedException
RecurringEventEnablers
matching the
given recurring event enabler query.recurringEventEnablerQuery
- the recurring event enabler query RecurringEventEnablerList
NullArgumentException
-
recurringEventEnablerQuery
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
-
recurringEventEnablerQuery
is not of this servicemandatory
- This method must be implemented.