public interface ScheduleSlotQuerySession extends OsidSession
This session provides methods for searching ScheduleSlot
objects. The search query is constructed using the
ScheduleSlotQuery.
The schedule slot record Type
also specifies the record for the schedule slot query.
This session defines views that offer differing behaviors for searching.
Schedule slots may have a query record indicated by their respective
record types. The query record is accessed via the
ScheduleSlotQuery.
Modifier and Type | Method and Description |
---|---|
boolean |
canSearchScheduleSlots()
Tests if this user can perform
ScheduleSlots searches. |
Calendar |
getCalendar()
Gets the
Calendar associated with this session. |
Id |
getCalendarId()
Gets the
Calendar Id associated with
this session. |
ScheduleSlotQuery |
getScheduleSlotQuery()
Gets a schedule slot query.
|
ScheduleSlotList |
getScheduleSlotsByQuery(ScheduleSlotQuery scheduleSlotQuery)
Gets a list of
ScheduleSlots matching the given
schedule slot query. |
void |
useFederatedCalendarView()
Federates the view for methods in this session.
|
void |
useIsolatedCalendarView()
Isolates the view for methods in this session.
|
void |
useSequesteredScheduleSlotView()
The returns from the search methods omit sequestered schedule slots.
|
void |
useUnsequesteredScheduleSlotView()
All schedule slots are returned including sequestered schedule slots.
|
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 canSearchScheduleSlots()
ScheduleSlots
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. void useSequesteredScheduleSlotView()
mandatory
- This method is must be implemented. void useUnsequesteredScheduleSlotView()
mandatory
- This method is must be implemented. ScheduleSlotQuery getScheduleSlotQuery()
mandatory
- This method must be implemented. ScheduleSlotList getScheduleSlotsByQuery(ScheduleSlotQuery scheduleSlotQuery) throws OperationFailedException, PermissionDeniedException
ScheduleSlots
matching the given
schedule slot query.scheduleSlotQuery
- the schedule slot query ScheduleSlotList
NullArgumentException
- scheduleSlotQuery
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- scheduleSlotQuery
is not of this servicemandatory
- This method must be implemented.