public interface OffsetEventCalendarSession extends OsidSession
This session provides methods to retrieve OffsetEvent
to
Calendar
mappings. An OffsetEvent
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 |
canLookupEventCalendarMappings()
Tests if this user can perform lookups of event/calendar mappings.
|
IdList |
getCalendarIdsByOffsetEvent(Id offsetEventId)
Gets the list of
Calendar Ids mapped to
an OffsetEvent. |
CalendarList |
getCalendarsByOffsetEvent(Id offsetEVentId)
Gets the list of
Calendars mapped to an
OffsetEvent. |
IdList |
getOffsetEventIdsByCalendar(Id calendarId)
Gets the list of
OffsetEvent Ids
associated with a Calendar. |
IdList |
getOffsetEventIdsByCalendars(IdList calendarIds)
Gets the list of
OffsetEvent Ids corresponding to a
list of Calendars. |
OffsetEventList |
getOffsetEventsByCalendar(Id calendarId)
Gets the list of
OffsetEvents associated with a
Calendar. |
OffsetEventList |
getOffsetEventsByCalendars(IdList calendarIds)
Gets the list of
OffsetEvents 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 canLookupEventCalendarMappings()
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 getOffsetEventIdsByCalendar(Id calendarId) throws NotFoundException, OperationFailedException, PermissionDeniedException
OffsetEvent
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. OffsetEventList getOffsetEventsByCalendar(Id calendarId) throws NotFoundException, OperationFailedException, PermissionDeniedException
OffsetEvents
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 getOffsetEventIdsByCalendars(IdList calendarIds) throws OperationFailedException, PermissionDeniedException
OffsetEvent 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. OffsetEventList getOffsetEventsByCalendars(IdList calendarIds) throws OperationFailedException, PermissionDeniedException
OffsetEvents
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 getCalendarIdsByOffsetEvent(Id offsetEventId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Calendar
Ids
mapped to
an OffsetEvent.
offsetEventId
- Id
of an OffsetEvent
Ids
NotFoundException
- offsetEventId
is not
foundNullArgumentException
- offsetEventId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. CalendarList getCalendarsByOffsetEvent(Id offsetEVentId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Calendars
mapped to an
OffsetEvent.
offsetEVentId
- Id
of an OffsetEvent
NotFoundException
- offsetEventId
is not
foundNullArgumentException
- offsetEventId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.