OSID Logo
OSID Specifications
tracking package
Version 3.0.0
Release Candidate Preview
Interfaceosid.tracking.FrontOfficeSearch
Implementsosid.OsidSearch
Description

The search interface for governing front office searches.

MethodsearchAmongFrontOffices
Description

Execute this search among the given list of frontOffices.

Parametersosid.id.IdListfrontOfficeIdslist of frontOffices
ErrorsNULL_ARGUMENT frontOfficeIds is null
CompliancemandatoryThis method must be implemented.
MethodorderFrontOfficeResults
Description

Specify an ordering to the search results.

Parametersosid.tracking.FrontOfficeSearchOrderfrontOfficeSearchOrderfront office search order
ErrorsNULL_ARGUMENT frontOfficeSearchOrder is null
UNSUPPORTED frontOfficeSearchOrder is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetFrontOfficeSearchRecord
Description

Gets the front office search record corresponding to the given front office search record Type. This method is used to retrieve an object implementing the requested record.

Parametersosid.type.TypefrontOfficeSearchRecordTypea front office search record type
Returnosid.tracking.records.FrontOfficeSearchRecordthe front office search record
ErrorsNULL_ARGUMENT frontOfficeSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(frontOfficeSearchRecordType) is false
CompliancemandatoryThis method must be implemented.