Interface | osid.calendaring.rules.RecurringEventEnablerQuerySession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session provides methods for searching among This session defines views that offer differing behaviors for searching.
Recurring event enablers may have a query record indicated
by their respective record types. The query record is accessed
via 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 | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canSearchRecurringEventEnablers | ||
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 event enablers in calendars which are children of this broker 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 | getRecurringEventEnablerQuery | ||
Description |
Gets a recurring event enabler query. | ||
Return | osid.calendaring.rules.RecurringEventEnablerQuery | the recurring event enabler query | |
Compliance | mandatory | This method must be implemented. | |
Method | getRecurringEventEnablersByQuery | ||
Description |
Gets a list of | ||
Parameters | osid.calendaring.rules.RecurringEventEnablerQuery | recurringEventEnablerQuery | the recurring event enabler query |
Return | osid.calendaring.rules.RecurringEventEnablerList | the returned RecurringEventEnablerList | |
Errors | NULL_ARGUMENT | recurringEventEnablerQuery is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | recurringEventEnablerQuery is not of this service | ||
Compliance | mandatory | This method must be implemented. |