Interface | osid.calendaring.cycle.CyclicEventSearchSession | ||
---|---|---|---|
Implements | osid.calendaring.cycle.CyclicEventQuerySession | ||
Description |
This session provides methods for searching This session defines views that offer differing behaviors for searching.
Cyclic events may have a query record indicated by their
respective record types. The query record is accessed via the
| ||
Method | getCyclicEventSearch | ||
Description |
Gets a cyclic event search. | ||
Return | osid.calendaring.cycle.CyclicEventSearch | the cyclic event search | |
Compliance | mandatory | This method must be implemented. | |
Method | getCyclicEventSearchOrder | ||
Description |
Gets a cyclic event search order. The | ||
Return | osid.calendaring.cycle.CyclicEventSearchOrder | the cyclic event search order | |
Compliance | mandatory | This method must be implemented. | |
Method | getCyclicEventsBySearch | ||
Description |
Gets the search results matching the given search query using the given search. | ||
Parameters | osid.calendaring.cycle.CyclicEventQuery | cyclicEventQuery | the cyclic event search query |
osid.calendaring.cycle.CyclicEventSearch | cyclicEventSearch | the cyclic event search | |
Return | osid.calendaring.cycle.CyclicEventSearchResults | the cyclic event search results | |
Errors | NULL_ARGUMENT | cyclicEventQuery or cyclicEventSearch is
null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | cyclicEventSearch or cyclicEventQuery is not
of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getCyclicEventQueryFromInspector | ||
Description |
Gets a cyclic event query from an inspector. The
inspector is available from a | ||
Parameters | osid.calendaring.cycle.CyclicEventQueryInspector | cyclicEventQueryInspector | a cyclic event query inspector |
Return | osid.calendaring.cycle.CyclicEventQuery | the cyclic event query | |
Errors | NULL_ARGUMENT | cyclicEventQueryInspector is null | |
UNSUPPORTED | cyclicEventQueryInspector is not of this service | ||
Compliance | mandatory | This method must be implemented. |