Interface | osid.calendaring.SupersedingEventSearchResults | ||
---|---|---|---|
Implements | osid.OsidSearchResults | ||
Description |
This interface provides a means to capture results of a search. | ||
Method | getSupersedingEvents | ||
Description |
Gets the superseding event list resulting from the search. | ||
Return | osid.calendaring.SupersedingEventList | the superseding event list | |
Errors | ILLEGAL_STATE | list already retrieved | |
Compliance | mandatory | This method must be implemented. | |
Method | getSupersedingEventQueryInspector | ||
Description |
Gets the inspector for the query to examine the terms used in the search. | ||
Return | osid.calendaring.SupersedingEventQueryInspector | the query inspector | |
Compliance | mandatory | This method must be implemented. | |
Method | getSupersedingEventSearchResultsRecord | ||
Description |
Gets the superseding event search results record
corresponding to the given superseding event search record
| ||
Parameters | osid.type.Type | supersedingEventSearchRecordType | a superseding event search record type |
Return | osid.calendaring.records.SupersedingEventSearchResultsRecord | the superseding event search results record | |
Errors | NULL_ARGUMENT | supersedingEventSearchRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(supersedingEventSearchRecordType) is
false | ||
Compliance | mandatory | This method must be implemented. |