Interface | osid.calendaring.EventSearchSession | ||
---|---|---|---|
Implements | osid.calendaring.EventQuerySession | ||
Description |
This session provides methods for searching This session defines views that offer differing behaviors for searching.
Events may have a query record indicated by their
respective record types. The query record is accessed via the
| ||
Method | getEventSearch | ||
Description |
Gets an event search. | ||
Return | osid.calendaring.EventSearch | the event search | |
Compliance | mandatory | This method must be implemented. | |
Method | getEventSearchOrder | ||
Description |
Gets an event search order. The | ||
Return | osid.calendaring.EventSearchOrder | the event search order | |
Compliance | mandatory | This method must be implemented. | |
Method | getEventsBySearch | ||
Description |
Gets the search results matching the given search query using the given search. | ||
Parameters | osid.calendaring.EventQuery | eventQuery | the event search query |
osid.calendaring.EventSearch | eventSearch | the event search | |
Return | osid.calendaring.EventSearchResults | the event search results | |
Errors | NULL_ARGUMENT | eventQuery or eventSearch is null
| |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | eventSearch or eventQuery is not of this
service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getEventQueryFromInspector | ||
Description |
Gets an event query from an inspector. The inspector is
available from an | ||
Parameters | osid.calendaring.EventQueryInspector | eventQueryInspector | an event query inspector |
Return | osid.calendaring.EventQuery | the event query | |
Errors | NULL_ARGUMENT | eventQueryInspector is null | |
UNSUPPORTED | eventQueryInspector is not of this service | ||
Compliance | mandatory | This method must be implemented. |