public interface RecurringEventCalendarSession extends OsidSession
This session provides methods to retrieve RecurringEvent
to Calendar
mappings. A RecurringEvent
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 |
canLookupRecurringEventCalendarMappings()
Tests if this user can perform lookups of recurring event/calendar
mappings.
|
IdList |
getCalendarIdsByRecurringEvent(Id recurringEventId)
Gets the list of
Calendar Ids mapped to
a RecurringEvent. |
CalendarList |
getCalendarsByRecurringEvent(Id recurringEventId)
Gets the list of
Calendars mapped to a
RecurringEvent. |
IdList |
getRecurringEventIdsByCalendar(Id calendarId)
Gets the list of
RecurringEvent Ids
associated with a Calendar. |
IdList |
getRecurringEventIdsByCalendars(IdList calendarIds)
Gets the list of
RecurringEvent Ids corresponding to a
list of Calendars. |
RecurringEventList |
getRecurringEventsByCalendar(Id calendarId)
Gets the list of
RecurringEvents associated with a
Calendar. |
RecurringEventList |
getRecurringEventsByCalendars(IdList calendarIds)
Gets the list of
RecurringEvents 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
Event and Calendar
returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canLookupRecurringEventCalendarMappings()
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 getRecurringEventIdsByCalendar(Id calendarId) throws NotFoundException, OperationFailedException, PermissionDeniedException
RecurringEvent
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. RecurringEventList getRecurringEventsByCalendar(Id calendarId) throws NotFoundException, OperationFailedException, PermissionDeniedException
RecurringEvents
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 getRecurringEventIdsByCalendars(IdList calendarIds) throws OperationFailedException, PermissionDeniedException
RecurringEvent 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. RecurringEventList getRecurringEventsByCalendars(IdList calendarIds) throws OperationFailedException, PermissionDeniedException
RecurringEvents
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 getCalendarIdsByRecurringEvent(Id recurringEventId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Calendar
Ids
mapped to
a RecurringEvent.
recurringEventId
- Id
of a RecurringEvent
Ids
NotFoundException
- recurringEventId
is
not foundNullArgumentException
- recurringEventId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. CalendarList getCalendarsByRecurringEvent(Id recurringEventId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Calendars
mapped to a
RecurringEvent.
recurringEventId
- Id
of a RecurringEvent
NotFoundException
- recurringEventId
is
not foundNullArgumentException
- recurringEventId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.