OSID Logo
OSID Specifications
workflow package
Version 3.1.0
Interfaceosid.workflow.OfficeSearchResults
Implementsosid.OsidSearchResults
Used Byosid.workflow.OfficeSearchSession
Description

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

MethodgetOffices
Description

Gets the office list resulting from a search.

Returnosid.workflow.OfficeList the office list
ErrorsILLEGAL_STATE list already retrieved
Compliancemandatory This method must be implemented.
MethodgetOfficeQueryInspector
Description

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

Returnosid.workflow.OfficeQueryInspector the office query inspector
Compliancemandatory This method must be implemented.
MethodgetOfficeSearchResultsRecord
Description

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

Parametersosid.type.TypeofficeSearchRecordType an office search record type
Returnosid.workflow.records.OfficeSearchResultsRecord the office search results record
ErrorsNULL_ARGUMENT officeSearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(officeSearchRecordType) is false
Compliancemandatory This method must be implemented.