public interface SupersedingEventEnablerCalendarSession extends OsidSession
This session provides methods to retrieve
SupersedingEventEnabler
to Calendar
mappings. A
SupersedingEventEnabler
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 |
canLookupSupersedingEventEnablerCalendarMappings()
Tests if this user can perform lookups of superseding event
enabler/calendar mappings.
|
IdList |
getCalendarIdsBySupersedingEventEnabler(Id supersedingEventEnablerId)
Gets the
Calendar Ids mapped to a
SupersedingEventEnabler. |
CalendarList |
getCalendarsBySupersedingEventEnabler(Id supersedingEventEnablerId)
Gets the
Calendars mapped to a
SupersedingEventEnabler. |
IdList |
getSupersedingEventEnablerIdsByCalendar(Id calendarId)
Gets the list of
SupersedingEventEnabler Ids associated
with a Calendar. |
IdList |
getSupersedingEventEnablerIdsByCalendars(IdList calendarIds)
Gets the list of
SupersedingEventEnabler Ids
corresponding to a list of Calendars. |
SupersedingEventEnablerList |
getSupersedingEventEnablersByCalendar(Id calendarId)
Gets the list of superseding event enablers associated with a
Calendar. |
SupersedingEventEnablerList |
getSupersedingEventEnablersByCalendars(IdList calendarIds)
Gets the list of superseding event enablers corresponding to a list of
Calendars. |
void |
useComparativeSupersedingEventEnablerCalendarView()
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 |
usePlenarySupersedingEventEnablerCalendarView()
A complete view of the
SupersedingEventEnabler and
Calendar returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canLookupSupersedingEventEnablerCalendarMappings()
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 useComparativeSupersedingEventEnablerCalendarView()
mandatory
- This method is must be implemented. void usePlenarySupersedingEventEnablerCalendarView()
SupersedingEventEnabler
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 getSupersedingEventEnablerIdsByCalendar(Id calendarId) throws NotFoundException, OperationFailedException, PermissionDeniedException
SupersedingEventEnabler 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. SupersedingEventEnablerList getSupersedingEventEnablersByCalendar(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 getSupersedingEventEnablerIdsByCalendars(IdList calendarIds) throws OperationFailedException, PermissionDeniedException
SupersedingEventEnabler 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. SupersedingEventEnablerList getSupersedingEventEnablersByCalendars(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 getCalendarIdsBySupersedingEventEnabler(Id supersedingEventEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Calendar
Ids
mapped to a
SupersedingEventEnabler.
supersedingEventEnablerId
- Id
of a
SupersedingEventEnabler
NotFoundException
- supersedingEventEnablerId
is not foundNullArgumentException
-
supersedingEventEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. CalendarList getCalendarsBySupersedingEventEnabler(Id supersedingEventEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Calendars
mapped to a
SupersedingEventEnabler.
supersedingEventEnablerId
- Id
of a
SupersedingEventEnabler
NotFoundException
- supersedingEventEnablerId
is not foundNullArgumentException
-
supersedingEventEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.