OSID Logo
OSID Specifications
resourcing package
Version 3.1.0
Interfaceosid.resourcing.WorkSearch
Implementsosid.OsidSearch
Used Byosid.resourcing.WorkSearchSession
Description

The search interface for governing work searches.

MethodsearchAmongWorks
Description

Execute this search among the given list of works.

Parametersosid.id.IdListworkIds list of works
ErrorsNULL_ARGUMENT workIds is null
Compliancemandatory This method must be implemented.
MethodorderWorkResults
Description

Specify an ordering to the search results.

Parametersosid.resourcing.WorkSearchOrderworkSearchOrder work search order
ErrorsNULL_ARGUMENT workSearchOrder is null
UNSUPPORTED workSearchOrder is not of this service
Compliancemandatory This 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.TypeworkSearchRecordType a work search record type
Returnosid.resourcing.records.WorkSearchRecord the work search record
ErrorsNULL_ARGUMENT workSearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(workSearchRecordType) is false
Compliancemandatory This method must be implemented.