OSID Logo
OSID Specifications
tracking package
Version 3.1.0
Interfaceosid.tracking.FrontOfficeSearchResults
Implementsosid.OsidSearchResults
Used Byosid.tracking.FrontOfficeSearchSession
Description

This interface provides a means to capture results of a search.

MethodgetFrontOffices
Description

Gets the front office list resulting from a search.

Returnosid.tracking.FrontOfficeList the front office list
ErrorsILLEGAL_STATE list already retrieved
Compliancemandatory This method must be implemented.
MethodgetFrontOfficeQueryInspector
Description

Gets the inspector for the query to examine the terms used in the search.

Returnosid.tracking.FrontOfficeQueryInspector the front office query inspector
Compliancemandatory This method must be implemented.
MethodgetFrontOfficeSearchResultsRecord
Description

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

Parametersosid.type.TypefrontOfficeSearchRecordType a front office search record type
Returnosid.tracking.records.FrontOfficeSearchResultsRecord the front office search results record
ErrorsNULL_ARGUMENT frontOfficeSearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(frontOfficeSearchRecordType) is false
Compliancemandatory This method must be implemented.