Interface | osid.calendaring.SupersedingEventLookupSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session provides methods for retrieving This session defines views that offer differing behaviors when retrieving multiple objects.
| ||
Method | getCalendarId | ||
Description |
Gets the | ||
Return | osid.id.Id | the Calendar Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getCalendar | ||
Description |
Gets the | ||
Return | osid.calendaring.Calendar | the Calendar associated with this session | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canLookupSupersedingEvents | ||
Description |
Tests if this user can perform | ||
Return | boolean | false if lookup methods are not authorized, true
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | useComparativeSupersedingEventView | ||
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 | usePlenarySupersedingEventView | ||
Description |
A complete view of the | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useFederatedCalendarView | ||
Description |
Federates the view for methods in this session. A federated view will include supserseding events in calendars which are children of this calendar in the calendar hierarchy. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useIsolatedCalendarView | ||
Description |
Isolates the view for methods in this session. An isolated view restricts lookups to this calendar only. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useActiveSupersedingEventView | ||
Description |
Only active superseding events are returned by methods in this session. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useAnyStatusSupersedingEventView | ||
Description |
All active and inactive superseding events are returned by methods in this session. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getSupersedingEvent | ||
Description |
Gets the In active mode, supersdeing events are returned that are currently active. In any status mode, active and inactive superseding events are returned. | ||
Parameters | osid.id.Id | supersedingEventId | Id of the SupersedingEvent |
Return | osid.calendaring.SupersedingEvent | the superseding event | |
Errors | NOT_FOUND | supersedngEventId not found | |
NULL_ARGUMENT | supersedingEventId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getSupersedingEventsByIds | ||
Description |
Gets a In active mode, supersdeing events are returned that are currently active. In any status mode, active and inactive superseding events are returned. | ||
Parameters | osid.id.IdList | supersedingEventIds | the list of Ids to retrieve |
Return | osid.calendaring.SupersedingEventList | the returned SupersedingEvent list | |
Errors | NOT_FOUND | an Id was not found | |
NULL_ARGUMENT | supersedingEventIds is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getSupersedingEventsByGenusType | ||
Description |
Gets a In active mode, supersdeing events are returned that are currently active. In any status mode, active and inactive superseding events are returned. | ||
Parameters | osid.type.Type | supersedingEventGenusType | a superseding event genus type |
Return | osid.calendaring.SupersedingEventList | the returned SupersedingEvent list | |
Errors | NULL_ARGUMENT | supersedingEventGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getSupersedingEventsByParentGenusType | ||
Description |
Gets a In active mode, supersdeing events are returned that are currently active. In any status mode, active and inactive superseding events are returned. | ||
Parameters | osid.type.Type | supersedingEventGenusType | a superseding event genus type |
Return | osid.calendaring.SupersedingEventList | the returned SupersedingEvent list | |
Errors | NULL_ARGUMENT | supersedingEventGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getSupersedingEventsByRecordType | ||
Description |
Gets a In active mode, supersdeing events are returned that are currently active. In any status mode, active and inactive superseding events are returned. | ||
Parameters | osid.type.Type | supersedingEventRecordType | a superseding event record type |
Return | osid.calendaring.SupersedingEventList | the returned SupersedingEvent list | |
Errors | NULL_ARGUMENT | supersedingEventRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getSupersedingEventsBySupersededEvent | ||
Description |
Gets the In plenary mode, the returned list contains all known superseding events or an error results. Otherwise, the returned list may contain only those superseding events that are accessible through this session. In active mode, supersdeing events are returned that are currently active. In any status mode, active and inactive superseding events are returned. | ||
Parameters | osid.id.Id | supersededEventId | Id of the related event |
Return | osid.calendaring.SupersedingEventList | the superseding events | |
Errors | NOT_FOUND | supersededEventId not found | |
NULL_ARGUMENT | supersededEventId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getSupersedingEvents | ||
Description |
Gets all In plenary mode, the returned list contains all known superseding events or an error results. Otherwise, the returned list may contain only those superseding events that are accessible through this session. In active mode, supersdeing events are returned that are currently active. In any status mode, active and inactive superseding events are returned. | ||
Return | osid.calendaring.SupersedingEventList | a SupersedingEventList | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |