public interface ScheduleSlotCalendarSession extends OsidSession
This session provides methods to retrieve ScheduleSlot
to Calendar
mappings. A ScheduleSlot
may
appear in multiple Calendars.
Each Calendar
may have its own authorizations governing who is allowed to look at it.
This lookup session defines two views:
Modifier and Type | Method and Description |
---|---|
boolean |
canLookupScheduleSlotCalendarMappings()
Tests if this user can perform lookups of schedule slot/calendar
mappings.
|
IdList |
getCalendarIdsByScheduleSlot(Id scheduleSlotId)
Gets the list of
Calendar Ids mapped to
a ScheduleSlot. |
CalendarList |
getCalendarsByScheduleSlot(Id scheduleSlotId)
Gets the list of
Calendars mapped to a
ScheduleSlot. |
IdList |
getScheduleSlotIdsByCalendar(Id calendarId)
Gets the list of
ScheduleSlot Ids
associated with a Calendar. |
IdList |
getScheduleSlotIdsByCalendars(IdList calendarIds)
Gets the list of
ScheduleSlot Ids corresponding to a
list of Calendars. |
ScheduleSlotList |
getScheduleSlotsByCalendar(Id calendarId)
Gets the list of
ScheduleSlots associated with a
Calendar. |
ScheduleSlotList |
getScheduleSlotsByCalendars(IdList calendarIds)
Gets the list of
ScheduleSlots corresponding to a list
of Calendars. |
void |
useComparativeCalendarView()
The returns from the lookup methods may omit or translate elements
based on this session, such as authorization, and not result in an
error.
|
void |
usePlenaryCalendarView()
A complete view of the
ScheduleSlot and Calendar
returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canLookupScheduleSlotCalendarMappings()
PERMISSION_DENIED.
This is intended as a hint to an application that may opt not
to offer lookup operations to unauthorized users. false
if looking up mappings is not authorized,
true
otherwisemandatory
- This method must be implemented. void useComparativeCalendarView()
mandatory
- This method is must be implemented. void usePlenaryCalendarView()
ScheduleSlot
and Calendar
returns is desired. Methods will return what is requested or
result in an error. This view is used when greater precision is
desired at the expense of interoperability.mandatory
- This method is must be implemented. IdList getScheduleSlotIdsByCalendar(Id calendarId) throws NotFoundException, OperationFailedException, PermissionDeniedException
ScheduleSlot
Ids
associated with a Calendar.
calendarId
- Id
of the Calendar
Ids
NotFoundException
- calendarId
is not
foundNullArgumentException
- calendarId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ScheduleSlotList getScheduleSlotsByCalendar(Id calendarId) throws NotFoundException, OperationFailedException, PermissionDeniedException
ScheduleSlots
associated with a
Calendar.
calendarId
- Id
of the Calendar
NotFoundException
- calendarId
is not
foundNullArgumentException
- calendarId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IdList getScheduleSlotIdsByCalendars(IdList calendarIds) throws OperationFailedException, PermissionDeniedException
ScheduleSlot Ids
corresponding to a
list of Calendars.
calendarIds
- list of calendar Ids
Ids
NullArgumentException
- calendarIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ScheduleSlotList getScheduleSlotsByCalendars(IdList calendarIds) throws OperationFailedException, PermissionDeniedException
ScheduleSlots
corresponding to a list
of Calendars.
calendarIds
- list of calendar Ids
NullArgumentException
- calendarIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IdList getCalendarIdsByScheduleSlot(Id scheduleSlotId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Calendar
Ids
mapped to
a ScheduleSlot.
scheduleSlotId
- Id
of a ScheduleSlot
Ids
NotFoundException
- scheduleSlotId
is
not foundNullArgumentException
- scheduleSlotId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. CalendarList getCalendarsByScheduleSlot(Id scheduleSlotId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Calendars
mapped to a
ScheduleSlot.
scheduleSlotId
- Id
of a ScheduleSlot
NotFoundException
- scheduleSlotId
is
not foundNullArgumentException
- scheduleSlotId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.