Interface | osid.calendaring.RecurringEventQuerySession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session provides methods for searching This session defines views that offer differing behaviors for searching.
| ||
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 | canSearchRecurringEvents | ||
Description |
Tests if this user can perform | ||
Return | boolean | false if search methods are not authorized, true
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | useFederatedCalendarView | ||
Description |
Federates the view for methods in this session. A federated view will include recurring 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 searches to this calendar only. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getRecurringEventQuery | ||
Description |
Gets a recurring event query. | ||
Return | osid.calendaring.RecurringEventQuery | the recurring event query | |
Compliance | mandatory | This method must be implemented. | |
Method | getRecurringEventsByQuery | ||
Description |
Gets a list of | ||
Parameters | osid.calendaring.RecurringEventQuery | recurringEventQuery | the recurring event query |
Return | osid.calendaring.RecurringEventList | the returned RecurringEventList | |
Errors | NULL_ARGUMENT | recurringEventQuery is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | recurringEventQuery is not of this service | ||
Compliance | mandatory | This method must be implemented. |