public interface ScheduleCalendarSession extends OsidSession
This session provides methods to retrieve Schedule
to
Calendar
mappings. A Schedule
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 |
canLookupScheduleCalendarMappings()
Tests if this user can perform lookups of schedule/calendar mappings.
|
IdList |
getCalendarIdsBySchedule(Id scheduleId)
Gets the list of
Calendar Ids mapped to
a Schedule. |
CalendarList |
getCalendarsBySchedule(Id scheduleId)
Gets the list of
Calendars mapped to a Schedule. |
IdList |
getScheduleIdsByCalendar(Id calendarId)
Gets the list of
Schedule Ids associated
with a Calendar. |
IdList |
getScheduleIdsByCalendars(IdList calendarIds)
Gets the list of
Schedule Ids corresponding to a list
of Calendars. |
ScheduleList |
getSchedulesByCalendar(Id calendarId)
Gets the list of
Schedules associated with a
Calendar. |
ScheduleList |
getSchedulesByCalendars(IdList calendarIds)
Gets the list of
Schedules 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
Schedule and Calendar
returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canLookupScheduleCalendarMappings()
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()
Schedule
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 getScheduleIdsByCalendar(Id calendarId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Schedule
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. ScheduleList getSchedulesByCalendar(Id calendarId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Schedules
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 getScheduleIdsByCalendars(IdList calendarIds) throws OperationFailedException, PermissionDeniedException
Schedule 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. ScheduleList getSchedulesByCalendars(IdList calendarIds) throws OperationFailedException, PermissionDeniedException
Schedules
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 getCalendarIdsBySchedule(Id scheduleId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Calendar
Ids
mapped to
a Schedule.
scheduleId
- Id
of a Schedule
Ids
NotFoundException
- scheduleId
is not
foundNullArgumentException
- scheduleId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. CalendarList getCalendarsBySchedule(Id scheduleId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Calendars
mapped to a Schedule.
scheduleId
- Id
of a Schedule
NotFoundException
- scheduleId
is not
foundNullArgumentException
- scheduleId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.