public interface CyclicEventQuerySession extends OsidSession
This session provides methods for searching CyclicEvent
objects. The search query is constructed using the
CyclicEventQuery.
The cyclic event record Type
also
specifies the record for the cyclic event query.
This session defines views that offer differing behaviors for searching.
Cyclic events may have a query record indicated by their respective
record types. The query record is accessed via the
CyclicEventQuery.
Modifier and Type | Method and Description |
---|---|
boolean |
canSearchCyclicEvents()
Tests if this user can perform
CyclicEvent searches. |
Calendar |
getCalendar()
Gets the
Calendar associated with this session. |
Id |
getCalendarId()
Gets the
Calendar Id associated with
this session. |
CyclicEventQuery |
getCyclicEventQuery()
Gets a cyclic event query.
|
CyclicEventList |
getCyclicEventsByQuery(CyclicEventQuery cyclicEventQuery)
Gets a list of
CyclicEvents matching the given cyclic
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 canSearchCyclicEvents()
CyclicEvent
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. CyclicEventQuery getCyclicEventQuery()
mandatory
- This method must be implemented. CyclicEventList getCyclicEventsByQuery(CyclicEventQuery cyclicEventQuery) throws OperationFailedException, PermissionDeniedException
CyclicEvents
matching the given cyclic
event query.cyclicEventQuery
- the cyclic event query EventList
NullArgumentException
- cyclicEventQuery
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- cyclicEventQuery
is not of this servicemandatory
- This method must be implemented.