OSID Logo
OSID Specifications
workflow package
Version 3.1.0
Interfaceosid.workflow.WorkSearchResults
Implementsosid.OsidSearchResults
Used Byosid.workflow.WorkSearchSession
Description

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

MethodgetWorks
Description

Gets the work list resulting from a search.

Returnosid.workflow.WorkList the work list
ErrorsILLEGAL_STATE list already retrieved
Compliancemandatory This method must be implemented.
MethodgetWorkQueryInspector
Description

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

Returnosid.workflow.WorkQueryInspector the work query inspector
Compliancemandatory This method must be implemented.
MethodgetWorkSearchResultsRecord
Description

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

Parametersosid.type.TypeworkSearchRecordType a work search record type
Returnosid.workflow.records.WorkSearchResultsRecord the work search results record
ErrorsNULL_ARGUMENT workSearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(workSearchRecordType) is false
Compliancemandatory This method must be implemented.