Interface | osid.calendaring.OffsetEventSearchResults | ||
---|---|---|---|
Implements | osid.OsidSearchResults | ||
Description |
This interface provides a means to capture results of a search. | ||
Method | getOffsetEvents | ||
Description |
Gets the offset event list resulting from the search. | ||
Return | osid.calendaring.OffsetEventList | the offset event list | |
Errors | ILLEGAL_STATE | list already retrieved | |
Compliance | mandatory | This method must be implemented. | |
Method | getOffsetEventQueryInspector | ||
Description |
Gets the inspector for the query to examine the terms used in the search. | ||
Return | osid.calendaring.OffsetEventQueryInspector | the query inspector | |
Compliance | mandatory | This method must be implemented. | |
Method | getOffsetEventSearchResultsRecord | ||
Description |
Gets the offset event search results record
corresponding to the given offset event search record
| ||
Parameters | osid.type.Type | offsetEventSearchRecordType | an offset event search record type |
Return | osid.calendaring.records.OffsetEventSearchResultsRecord | the offset event search results record | |
Errors | NULL_ARGUMENT | offsetEventSearchRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(offsetEventSearchRecordType) is false
| ||
Compliance | mandatory | This method must be implemented. |