Interface | osid.resourcing.AvailabilitySearch | ||
---|---|---|---|
Implements | osid.OsidSearch | ||
Description |
The search interface for governing availability searches. | ||
Method | searchAmongAvailabilities | ||
Description |
Execute this search among the given list of availabilities. | ||
Parameters | osid.id.IdList | availabilityIds | list of availabilities |
Errors | NULL_ARGUMENT | availabilityIds is null | |
Compliance | mandatory | This method must be implemented. | |
Method | orderAvailabilityResults | ||
Description |
Specify an ordering to the search results. | ||
Parameters | osid.resourcing.AvailabilitySearchOrder | availabilitySearchOrder | availability search order |
Errors | NULL_ARGUMENT | availabilitySearchOrder is null | |
UNSUPPORTED | availabilitySearchOrder is not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getAvailabilitySearchRecord | ||
Description |
Gets the availability search record corresponding to
the given availability search record | ||
Parameters | osid.type.Type | availabilitySearchRecordType | an availability search record type |
Return | osid.resourcing.records.AvailabilitySearchRecord | the availability search 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. |