Interface | osid.tracking.FrontOfficeSearch | ||
---|---|---|---|
Implements | osid.OsidSearch | ||
Description |
The search interface for governing front office searches. | ||
Method | searchAmongFrontOffices | ||
Description |
Execute this search among the given list of frontOffices. | ||
Parameters | osid.id.IdList | frontOfficeIds | list of frontOffices |
Errors | NULL_ARGUMENT | frontOfficeIds is null | |
Compliance | mandatory | This method must be implemented. | |
Method | orderFrontOfficeResults | ||
Description |
Specify an ordering to the search results. | ||
Parameters | osid.tracking.FrontOfficeSearchOrder | frontOfficeSearchOrder | front office search order |
Errors | NULL_ARGUMENT | frontOfficeSearchOrder is null | |
UNSUPPORTED | frontOfficeSearchOrder is not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getFrontOfficeSearchRecord | ||
Description |
Gets the front office search record corresponding to
the given front office search record | ||
Parameters | osid.type.Type | frontOfficeSearchRecordType | a front office search record type |
Return | osid.tracking.records.FrontOfficeSearchRecord | the front office search record | |
Errors | NULL_ARGUMENT | frontOfficeSearchRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(frontOfficeSearchRecordType) is false
| ||
Compliance | mandatory | This method must be implemented. |