Interface | osid.calendaring.cycle.CyclicEventLookupSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session provides methods for retrieving This session defines views that offer differing behaviors when retrieving multiple objects.
Cyclic events may have an additional records indicated by
their respective record types. The record may not be accessed
through a cast of the | ||
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 | canLookupCyclicEvents | ||
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 | useComparativeCyclicEventView | ||
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 | usePlenaryCyclicEventView | ||
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 cyclic 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 | getCyclicEvent | ||
Description |
Gets the | ||
Parameters | osid.id.Id | cyclicEventId | Id of the CyclicEvent |
Return | osid.calendaring.cycle.CyclicEvent | the cyclic event | |
Errors | NOT_FOUND | cyclicEventId not found | |
NULL_ARGUMENT | cyclicEventId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getCyclicEventsByIds | ||
Description |
Gets a | ||
Parameters | osid.id.IdList | cyclicEventIds | the list of Ids to retrieve |
Return | osid.calendaring.cycle.CyclicEventList | the returned CyclicEvent list | |
Errors | NOT_FOUND | an Id was not found | |
NULL_ARGUMENT | cyclicEventIds is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getCyclicEventsByGenusType | ||
Description |
Gets a | ||
Parameters | osid.type.Type | cyclicEventGenusType | a cyclic event genus type |
Return | osid.calendaring.cycle.CyclicEventList | the returned Event list | |
Errors | NULL_ARGUMENT | cyclicEventGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getCyclicEventsByParentGenusType | ||
Description |
Gets a | ||
Parameters | osid.type.Type | cyclicEventGenusType | a cyclic event genus type |
Return | osid.calendaring.cycle.CyclicEventList | the returned CyclicEvent list | |
Errors | NULL_ARGUMENT | cyclicEventGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getCyclicEventsByRecordType | ||
Description |
Gets a | ||
Parameters | osid.type.Type | cyclicEventRecordType | a cyclic event record type |
Return | osid.calendaring.cycle.CyclicEventList | the returned Event list | |
Errors | NULL_ARGUMENT | cyclicEventRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getCyclicEvents | ||
Description |
Gets all | ||
Return | osid.calendaring.cycle.CyclicEventList | a CyclicEventList | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |