OSID Logo
OSID Specifications
tracking package
Version 3.0.0
Release Candidate Preview
Interfaceosid.tracking.FrontOfficeSearchResults
Implementsosid.OsidSearchResults
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.FrontOfficeListthe front office list
ErrorsILLEGAL_STATElist already retrieved
CompliancemandatoryThis method must be implemented.
MethodgetFrontOfficeQueryInspector
Description

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

Returnosid.tracking.FrontOfficeQueryInspectorthe front office query inspector
CompliancemandatoryThis 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.TypefrontOfficeSearchRecordTypea front office search record type
Returnosid.tracking.records.FrontOfficeSearchResultsRecordthe front office search results record
ErrorsNULL_ARGUMENT frontOfficeSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(frontOfficeSearchRecordType) is false
CompliancemandatoryThis method must be implemented.