public interface RecurringEventEnablerCalendarSession extends OsidSession
This session provides methods to retrieve RecurringEventEnabler
to Calendar
mappings. A
RecurringEventEnabler
may appear in multiple Calendar
objects. Each calendar may have its own authorizations governing
who is allowed to look at it.
This lookup session defines several views:
Modifier and Type | Method and Description |
---|---|
boolean |
canLookupRecurringEventEnablerCalendarMappings()
Tests if this user can perform lookups of recurring event
enabler/calendar mappings.
|
IdList |
getCalendarIdsByRecurringEventEnabler(Id recurringEventEnablerId)
Gets the
Calendar Ids mapped to a
RecurringEventEnabler |
CalendarList |
getCalendarsByRecurringEventEnabler(Id recurringEventEnablerId)
Gets the
Calendars mapped to a
RecurringEventEnabler. |
IdList |
getRecurringEventEnablerIdsByCalendar(Id calendarId)
Gets the list of
RecurringEventEnabler Ids associated
with a Calendar. |
IdList |
getRecurringEventEnablerIdsByCalendars(IdList calendarIds)
Gets the list of
RecurringEventEnabler Ids
corresponding to a list of Calendars. |
RecurringEventEnablerList |
getRecurringEventEnablersByCalendar(Id calendarId)
Gets the list of recurring event enablers associated with a
Calendar. |
RecurringEventEnablerList |
getRecurringEventEnablersByCalendars(IdList calendarIds)
Gets the list of recurring event enablers corresponding to a list of
Calendars. |
void |
useComparativeRecurringEventEnablerCalendarView()
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 |
usePlenaryRecurringEventEnablerCalendarView()
A complete view of the
RecurringEventEnabler and
Calendar returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canLookupRecurringEventEnablerCalendarMappings()
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 useComparativeRecurringEventEnablerCalendarView()
mandatory
- This method is must be implemented. void usePlenaryRecurringEventEnablerCalendarView()
RecurringEventEnabler
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 getRecurringEventEnablerIdsByCalendar(Id calendarId) throws NotFoundException, OperationFailedException, PermissionDeniedException
RecurringEventEnabler 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. RecurringEventEnablerList getRecurringEventEnablersByCalendar(Id calendarId) throws NotFoundException, OperationFailedException, PermissionDeniedException
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 getRecurringEventEnablerIdsByCalendars(IdList calendarIds) throws OperationFailedException, PermissionDeniedException
RecurringEventEnabler 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. RecurringEventEnablerList getRecurringEventEnablersByCalendars(IdList calendarIds) throws OperationFailedException, PermissionDeniedException
Calendars.
calendarIds
- list of calendar Ids
NullArgumentException
- calendarIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IdList getCalendarIdsByRecurringEventEnabler(Id recurringEventEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Calendar
Ids
mapped to a
RecurringEventEnabler
recurringEventEnablerId
- Id
of a
RecurringEventEnabler
NotFoundException
- recurringEventEnablerId
is not foundNullArgumentException
- recurringEventEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. CalendarList getCalendarsByRecurringEventEnabler(Id recurringEventEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Calendars
mapped to a
RecurringEventEnabler.
recurringEventEnablerId
- Id
of a
RecurringEventEnabler
NotFoundException
- recurringEventEnablerId
is not foundNullArgumentException
- recurringEventEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.