Interface | osid.subscription.DispatchSearchSession | ||
---|---|---|---|
Implements | osid.subscription.DispatchQuerySession | ||
Description |
This session provides methods for searching Dispatches may have a query record indicated by their
respective record types. The query record is accessed via the
| ||
Method | getDispatchSearch | ||
Description |
Gets a dispatch search. | ||
Return | osid.subscription.DispatchSearch | the dispatch search | |
Compliance | mandatory | This method must be implemented. | |
Method | getDispatchSearchOrder | ||
Description |
Gets a dispatch search order. The | ||
Return | osid.subscription.DispatchSearchOrder | the dispatch search order | |
Compliance | mandatory | This method must be implemented. | |
Method | getDispatchesBySearch | ||
Description |
Gets the search results matching the given search. | ||
Parameters | osid.subscription.DispatchQuery | dispatchQuery | the dispatch query |
osid.subscription.DispatchSearch | dispatchSearch | the dispatch search | |
Return | osid.subscription.DispatchSearchResults | the dispatch search results | |
Errors | NULL_ARGUMENT | dispatchQuery or dispatchSearch is
null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | dispatchQuery or dispatchSearch is not of
this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getDispatchQueryFromInspector | ||
Description |
Gets an entry query from an inspector. The inspector is
available from an | ||
Parameters | osid.subscription.DispatchQueryInspector | dispatchQueryInspector | a query inspector |
Return | osid.subscription.DispatchQuery | the entry query | |
Errors | NULL_ARGUMENT | dispatchQueryInspector is null | |
UNSUPPORTED | dispatchQueryInspector is not of this service | ||
Compliance | mandatory | This method must be implemented. |