Interface | osid.tracking.FrontOfficeSearchSession | ||
---|---|---|---|
Implements | osid.tracking.FrontOfficeQuerySession | ||
Description |
This session provides methods for searching among FrontOffices may have a query record indicated by their
respective record types. The query record is accessed via the
| ||
Method | getFrontOfficeSearch | ||
Description |
Gets a front office search. | ||
Return | osid.tracking.FrontOfficeSearch | the front office search | |
Compliance | mandatory | This method must be implemented. | |
Method | getFrontOfficeSearchOrder | ||
Description |
Gets a front office search order. The | ||
Return | osid.tracking.FrontOfficeSearchOrder | the front office search order | |
Compliance | mandatory | This method must be implemented. | |
Method | getFrontOfficesBySearch | ||
Description |
Gets the search results matching the given search query using the given search. | ||
Parameters | osid.tracking.FrontOfficeQuery | frontOfficeQuery | the front office query |
osid.tracking.FrontOfficeSearch | frontOfficeSearch | the front office search | |
Return | osid.tracking.FrontOfficeSearchResults | the returned search results | |
Errors | NULL_ARGUMENT | frontOfficeQuery or frontOfficeSearch is
null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | frontOfficeQuery or frontOfficeSearch is not
of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getFrontOfficeQueryFromInspector | ||
Description |
Gets a front office query from an inspector. The
inspector is available from a | ||
Parameters | osid.tracking.FrontOfficeQueryInspector | frontOfficeQueryInspector | a front office query inspector |
Return | osid.tracking.FrontOfficeQuery | the front office query | |
Errors | NULL_ARGUMENT | frontOfficeQueryInspector is null | |
UNSUPPORTED | frontOfficeQueryInspector is not of this service | ||
Compliance | mandatory | This method must be implemented. |