OSID Logo
OSID Specifications
workflow package
Version 3.0.0
Release Candidate Preview
Interfaceosid.workflow.WorkSearchResults
Implementsosid.OsidSearchResults
Description

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

MethodgetWorks
Description

Gets the work list resulting from a search.

Returnosid.workflow.WorkListthe work list
ErrorsILLEGAL_STATElist already retrieved
CompliancemandatoryThis method must be implemented.
MethodgetWorkQueryInspector
Description

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

Returnosid.workflow.WorkQueryInspectorthe work query inspector
CompliancemandatoryThis 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.TypeworkSearchRecordTypea work search record type
Returnosid.workflow.records.WorkSearchResultsRecordthe work search results record
ErrorsNULL_ARGUMENT workSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(workSearchRecordType) is false
CompliancemandatoryThis method must be implemented.