Interface | osid.resourcing.AvailabilitySearchSession | ||
---|---|---|---|
Implements | osid.resourcing.AvailabilityQuerySession | ||
Description |
This session provides methods for searching among This session defines views that offer differing behaviors for searching.
Availabilitys may have a query record indicated by their
respective record types. The query record is accessed via the
| ||
Method | getAvailabilitySearch | ||
Description |
Gets an availability search. | ||
Return | osid.resourcing.AvailabilitySearch | the availability search | |
Compliance | mandatory | This method must be implemented. | |
Method | getAvailabilitySearchOrder | ||
Description |
Gets an availability search order. The | ||
Return | osid.resourcing.AvailabilitySearchOrder | the availability search order | |
Compliance | mandatory | This method must be implemented. | |
Method | getAvailabilitiesBySearch | ||
Description |
Gets the search results matching the given search query using the given search. | ||
Parameters | osid.resourcing.AvailabilityQuery | availabilityQuery | the availability query |
osid.resourcing.AvailabilitySearch | availabilitySearch | the availability search | |
Return | osid.resourcing.AvailabilitySearchResults | the returned search results | |
Errors | NULL_ARGUMENT | availabilityQuery or availabilitySearch is
null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | availabilityQuery or availabilitySearch is
not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getAvailabilityQueryFromInspector | ||
Description |
Gets an availability query from an inspector. The
inspector is available from an | ||
Parameters | osid.resourcing.AvailabilityQueryInspector | availabilityQueryInspector | an availability query inspector |
Return | osid.resourcing.AvailabilityQuery | the availability query | |
Errors | NULL_ARGUMENT | availabilityQueryInspector is null | |
UNSUPPORTED | availabilityQueryInspector is not of this service | ||
Compliance | mandatory | This method must be implemented. |