Interface | osid.calendaring.RecurringEventSearchSession | ||
---|---|---|---|
Implements | osid.calendaring.RecurringEventQuerySession | ||
Description |
This session provides methods for searching This session defines views that offer differing behaviors for searching.
Recurring events may have a query record indicated by
their respective record types. The query record is accessed
via the | ||
Method | getRecurringEventSearch | ||
Description |
Gets a recurring event search. | ||
Return | osid.calendaring.RecurringEventSearch | the recurring event search | |
Compliance | mandatory | This method must be implemented. | |
Method | getRecurringEventSearchOrder | ||
Description |
Gets a recurring event search order. The | ||
Return | osid.calendaring.RecurringEventSearchOrder | the recurring event search order | |
Compliance | mandatory | This method must be implemented. | |
Method | getRecurringEventsBySearch | ||
Description |
Gets the search results matching the given search query using the given search. | ||
Parameters | osid.calendaring.RecurringEventQuery | recurringEventQuery | the recurring event search query |
osid.calendaring.RecurringEventSearch | recurringEventSearch | the recurring event search | |
Return | osid.calendaring.RecurringEventSearchResults | the recurring event search results | |
Errors | NULL_ARGUMENT | recurringEventQuery or recurringEventSearch
is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | recurringEventSearch or recurringEventQuery
is not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getRecurringEventQueryFromInspector | ||
Description |
Gets a recurring event query from an inspector. The
inspector is available from a | ||
Parameters | osid.calendaring.RecurringEventQueryInspector | recurringEventQueryInspector | a recurring event query inspector |
Return | osid.calendaring.RecurringEventQuery | the recurring event query | |
Errors | NULL_ARGUMENT | recurringEventQueryInspector is null | |
UNSUPPORTED | recurringEventQueryInspector is not of this service | ||
Compliance | mandatory | This method must be implemented. |