public interface EventCalendarSession extends OsidSession
This session provides methods to retrieve Event
to
Calendar
mappings. An Event
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 |
getCalendarIdsByEvent(Id eventId)
Gets the list of
Calendar Ids mapped to
an Event. |
CalendarList |
getCalendarsByEvent(Id eventId)
Gets the list of
Calendars mapped to an Event. |
IdList |
getEventIdsByCalendar(Id calendarId)
Gets the list of
Event Ids associated
with a Calendar. |
IdList |
getEventIdsByCalendars(IdList calendarIds)
Gets the list of
Event Ids corresponding to a list of
Calendars. |
EventList |
getEventsByCalendar(Id calendarId)
Gets the list of
Events associated with a
Calendar. |
EventList |
getEventsByCalendars(IdList calendarIds)
Gets the list of
Events 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 |
useDenormalizedEventView()
A denormalized view sends a separate notification for each event in a
recurring set.
|
void |
useNormalizedEventView()
A normalized view sends a single notification for recurring events.
|
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. void useNormalizedEventView()
mandatory
- This method is must be implemented. void useDenormalizedEventView()
mandatory
- This method is must be implemented. IdList getEventIdsByCalendar(Id calendarId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Event
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. EventList getEventsByCalendar(Id calendarId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Events
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 getEventIdsByCalendars(IdList calendarIds) throws OperationFailedException, PermissionDeniedException
Event 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. EventList getEventsByCalendars(IdList calendarIds) throws OperationFailedException, PermissionDeniedException
Events
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 getCalendarIdsByEvent(Id eventId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Calendar
Ids
mapped to
an Event.
eventId
- Id
of an Event
Ids
NotFoundException
- eventId
is not foundNullArgumentException
- eventId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. CalendarList getCalendarsByEvent(Id eventId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Calendars
mapped to an Event.
eventId
- Id
of an Event
NotFoundException
- eventId
is not foundNullArgumentException
- eventId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.