Interface | osid.calendaring.EventSearchResults | ||
---|---|---|---|
Implements | osid.OsidSearchResults | ||
Description |
This interface provides a means to capture results of a search. | ||
Method | getEvents | ||
Description |
Gets the event list resulting from the search. | ||
Return | osid.calendaring.EventList | the event list | |
Errors | ILLEGAL_STATE | list already retrieved | |
Compliance | mandatory | This method must be implemented. | |
Method | getEventQueryInspector | ||
Description |
Gets the inspector for the query to examine the terms used in the search. | ||
Return | osid.calendaring.EventQueryInspector | the query inspector | |
Compliance | mandatory | This method must be implemented. | |
Method | getEventSearchResultsRecord | ||
Description |
Gets the event search results record corresponding to
the given event search record | ||
Parameters | osid.type.Type | eventSearchRecordType | an event search record type |
Return | osid.calendaring.records.EventSearchResultsRecord | the event search results record | |
Errors | NULL_ARGUMENT | eventSearchRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(eventSearchRecordType) is false | ||
Compliance | mandatory | This method must be implemented. |