Interface | osid.calendaring.SupersedingEventSearchSession | ||
---|---|---|---|
Implements | osid.calendaring.SupersedingEventQuerySession | ||
Description |
This session provides methods for searching This session defines views that offer differing behaviors for searching.
Superseding events may have a query record indicated by
their respective record types. The query record is accessed
via the | ||
Method | getSupersedingEventSearch | ||
Description |
Gets a superseding event search. | ||
Return | osid.calendaring.SupersedingEventSearch | the superseding event search | |
Compliance | mandatory | This method must be implemented. | |
Method | getSupersedingEventSearchOrder | ||
Description |
Gets a superseding event search order. The | ||
Return | osid.calendaring.SupersedingEventSearchOrder | the superseding event search order | |
Compliance | mandatory | This method must be implemented. | |
Method | getSupersedingEventsBySearch | ||
Description |
Gets the search results matching the given search query using the given search. | ||
Parameters | osid.calendaring.SupersedingEventQuery | supersedingEventQuery | the superseding search query |
osid.calendaring.SupersedingEventSearch | supersedingEventSearch | the superseding search | |
Return | osid.calendaring.SupersedingEventSearchResults | the returned search results | |
Errors | NULL_ARGUMENT | supersedingEventQuery or supersedingEventSearch
is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | supersedingEventQuery is not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getSupersedingEventQueryFromInspector | ||
Description |
Gets a superseding event query from an inspector. The
inspector is available from a | ||
Parameters | osid.calendaring.SupersedingEventQueryInspector | supersedingEventQueryInspector | a superseding event query inspector |
Return | osid.calendaring.SupersedingEventQuery | the superseding event query | |
Errors | NULL_ARGUMENT | supersedingEventQueryInspector is null | |
UNSUPPORTED | supersedingEventQueryInspector is not of this service | ||
Compliance | mandatory | This method must be implemented. |