Interface | osid.resourcing.AvailabilitySearchResults | ||
---|---|---|---|
Implements | osid.OsidSearchResults | ||
Description |
This interface provides a means to capture results of a search. | ||
Method | getAvailabilities | ||
Description |
Gets the availability list resulting from a search. | ||
Return | osid.resourcing.AvailabilityList | the availability list | |
Errors | ILLEGAL_STATE | list already retrieved | |
Compliance | mandatory | This method must be implemented. | |
Method | getAvailabilityQueryInspector | ||
Description |
Gets the inspector for the query to examine the terms used in the search. | ||
Return | osid.resourcing.AvailabilityQueryInspector | the availability query inspector | |
Compliance | mandatory | This method must be implemented. | |
Method | getAvailabilitySearchResultsRecord | ||
Description |
Gets the availability search results record
corresponding to the given availability search record
| ||
Parameters | osid.type.Type | availabilitySearchRecordType | an availability search record type |
Return | osid.resourcing.records.AvailabilitySearchResultsRecord | the availability search results record | |
Errors | NULL_ARGUMENT | availabilitySearchRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(availabilitySearchRecordType) is false
| ||
Compliance | mandatory | This method must be implemented. |