Interface | osid.calendaring.EventCalendarSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session provides methods to retrieve This lookup session defines two views:
| ||
Method | canLookupEventCalendarMappings | ||
Description |
Tests if this user can perform lookups of
event/calendar mappings. A return of true does not
guarantee successful authorization. A return of false
indicates that it is known lookup methods in this session
will result in a | ||
Return | boolean | false if looking up mappings is not authorized, true
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | useComparativeCalendarView | ||
Description |
The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | usePlenaryCalendarView | ||
Description |
A complete view of the | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useNormalizedEventView | ||
Description |
A normalized view sends a single notification for recurring events. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useDenormalizedEventView | ||
Description |
A denormalized view sends a separate notification for each event in a recurring set. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getEventIdsByCalendar | ||
Description |
Gets the list of | ||
Parameters | osid.id.Id | calendarId | Id of the Calendar |
Return | osid.id.IdList | list of related event Ids | |
Errors | NOT_FOUND | calendarId is not found | |
NULL_ARGUMENT | calendarId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getEventsByCalendar | ||
Description |
Gets the list of | ||
Parameters | osid.id.Id | calendarId | Id of the Calendar |
Return | osid.calendaring.EventList | list of related events | |
Errors | NOT_FOUND | calendarId is not found | |
NULL_ARGUMENT | calendarId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getEventIdsByCalendars | ||
Description |
Gets the list of | ||
Parameters | osid.id.IdList | calendarIds | list of calendar Ids |
Return | osid.id.IdList | list of event Ids | |
Errors | NULL_ARGUMENT | calendarIds is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getEventsByCalendars | ||
Description |
Gets the list of | ||
Parameters | osid.id.IdList | calendarIds | list of calendar Ids |
Return | osid.calendaring.EventList | list of events | |
Errors | NULL_ARGUMENT | calendarIds is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getCalendarIdsByEvent | ||
Description |
Gets the list of | ||
Parameters | osid.id.Id | eventId | Id of an Event |
Return | osid.id.IdList | list of calendar Ids | |
Errors | NOT_FOUND | eventId is not found | |
NULL_ARGUMENT | eventId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getCalendarsByEvent | ||
Description |
Gets the list of | ||
Parameters | osid.id.Id | eventId | Id of an Event |
Return | osid.calendaring.CalendarList | list of calendars | |
Errors | NOT_FOUND | eventId is not found | |
NULL_ARGUMENT | eventId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |