OSID Logo
OSID Specifications
workflow package
Version 3.0.0
Interfaceosid.workflow.WorkSearch
Implementsosid.OsidSearch
Used Byosid.workflow.WorkSearchSession
Description

The search interface for governing work searches.

MethodsearchAmongWorks
Description

Execute this search among the given list of works.

Parametersosid.id.IdListworkIdslist of works
ErrorsNULL_ARGUMENTworkIds is null
CompliancemandatoryThis method must be implemented.
MethodorderWorkResults
Description

Specify an ordering to the search results.

Parametersosid.workflow.WorkSearchOrderworkSearchOrderwork search order
ErrorsNULL_ARGUMENTworkSearchOrder is null
UNSUPPORTEDworkSearchOrder is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetWorkSearchRecord
Description

Gets the work search 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.WorkSearchRecordthe work search record
ErrorsNULL_ARGUMENTworkSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTEDhasRecordType(workSearchRecordType) is false
CompliancemandatoryThis method must be implemented.