public interface OffsetEventEnablerCalendarSession extends OsidSession
This session provides methods to retrieve OffsetEventEnabler
to Calendar
mappings. An OffsetEventEnabler
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 |
canLookupOffsetEventEnablerCalendarMappings()
Tests if this user can perform lookups of offset event
enabler/calendar mappings.
|
IdList |
getCalendarIdsByOffsetEventEnabler(Id offsetEventEnablerId)
Gets the
Calendar Ids mapped to an
OffsetEventEnabler. |
CalendarList |
getCalendarsByOffsetEventEnabler(Id offsetEventEnablerId)
Gets the
Calendars mapped to an
OffsetEventEnabler. |
IdList |
getOffsetEventEnablerIdsByCalendar(Id calendarId)
Gets the list of
OffsetEventEnabler Ids associated with
a Calendar. |
IdList |
getOffsetEventEnablerIdsByCalendars(IdList calendarIds)
Gets the list of
OffsetEventEnabler Ids corresponding
to a list of Calendars. |
OffsetEventEnablerList |
getOffsetEventEnablersByCalendar(Id calendarId)
Gets the list of offset event enablers associated with a
Calendar. |
OffsetEventEnablerList |
getOffsetEventEnablersByCalendars(IdList calendarIds)
Gets the list of offset event enablers corresponding to a list of
Calendars. |
void |
useComparativeOffsetEventEnablerCalendarView()
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 |
usePlenaryOffsetEventEnablerCalendarView()
A complete view of the
OffsetEventEnabler and
Calendar returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canLookupOffsetEventEnablerCalendarMappings()
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 useComparativeOffsetEventEnablerCalendarView()
mandatory
- This method is must be implemented. void usePlenaryOffsetEventEnablerCalendarView()
OffsetEventEnabler
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 getOffsetEventEnablerIdsByCalendar(Id calendarId) throws NotFoundException, OperationFailedException, PermissionDeniedException
OffsetEventEnabler 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. OffsetEventEnablerList getOffsetEventEnablersByCalendar(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 getOffsetEventEnablerIdsByCalendars(IdList calendarIds) throws OperationFailedException, PermissionDeniedException
OffsetEventEnabler 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. OffsetEventEnablerList getOffsetEventEnablersByCalendars(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 getCalendarIdsByOffsetEventEnabler(Id offsetEventEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Calendar
Ids
mapped to an
OffsetEventEnabler.
offsetEventEnablerId
- Id
of an
OffsetEventEnabler
NotFoundException
- offsetEventEnablerId
is not foundNullArgumentException
- offsetEventEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. CalendarList getCalendarsByOffsetEventEnabler(Id offsetEventEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Calendars
mapped to an
OffsetEventEnabler.
offsetEventEnablerId
- Id
of an
OffsetEventEnabler
NotFoundException
- offsetEventEnablerId
is not foundNullArgumentException
- offsetEventEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.