public interface SupersedingEventCalendarSession extends OsidSession
This session provides methods to retrieve SupersedingEvent
to Calendar
mappings. A SupersedingEvent
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 |
canLookupSupersedingEventCalendarMappings()
Tests if this user can perform lookups of superseding event/calendar
mappings.
|
CalendarList |
getCalendarsBySupersedingEvent(Id supersedingEventId)
Gets the list of
Calendars mapped to a
SupersedingEvent. |
IdList |
getSupersedingEventIdsByCalendar(Id calendarId)
Gets the list of
SupersedingEvent Ids
associated with a Calendar. |
IdList |
getSupersedingEventIdsByCalendars(IdList calendarIds)
Gets the list of
SupersedingEvent Ids corresponding to
a list of Calendars. |
SupersedingEventList |
getSupersedingEventsByCalendar(Id calendarId)
Gets the list of
SupersedingEvents associated with a
Calendar. |
SupersedingEventList |
getSupersedingEventsByCalendars(IdList calendarIds)
Gets the list of
SupersedingEvents corresponding to a
list of Calendars. |
IdList |
getSupersedingIdsByRecurringEvent(Id supersedingEventId)
Gets the list of
Calendar Ids mapped to
a SupersedingEvent. |
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
Event and Calendar
returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canLookupSupersedingEventCalendarMappings()
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()
Event
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 getSupersedingEventIdsByCalendar(Id calendarId) throws NotFoundException, OperationFailedException, PermissionDeniedException
SupersedingEvent
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. SupersedingEventList getSupersedingEventsByCalendar(Id calendarId) throws NotFoundException, OperationFailedException, PermissionDeniedException
SupersedingEvents
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 getSupersedingEventIdsByCalendars(IdList calendarIds) throws OperationFailedException, PermissionDeniedException
SupersedingEvent 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. SupersedingEventList getSupersedingEventsByCalendars(IdList calendarIds) throws OperationFailedException, PermissionDeniedException
SupersedingEvents
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 getSupersedingIdsByRecurringEvent(Id supersedingEventId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Calendar
Ids
mapped to
a SupersedingEvent.
supersedingEventId
- Id
of a
SupersedingEvent
Ids
NotFoundException
- supersedingEventId
is not foundNullArgumentException
- supesredingEventId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. CalendarList getCalendarsBySupersedingEvent(Id supersedingEventId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Calendars
mapped to a
SupersedingEvent.
supersedingEventId
- Id
of a
SupersedingEvent
NotFoundException
- supersedingEventId
is not foundNullArgumentException
- supesredingEventId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.