OSID Logo
OSID Specifications
resourcing package
Version 3.1.0
Interfaceosid.resourcing.EffortSearch
Implementsosid.OsidSearch
Used Byosid.resourcing.EffortSearchSession
Description

The search interface for governing effort searches.

MethodsearchAmongEfforts
Description

Execute this search among the given list of efforts.

Parametersosid.id.IdListeffortIds list of efforts
ErrorsNULL_ARGUMENT effortIds is null
Compliancemandatory This method must be implemented.
MethodorderEffortResults
Description

Specify an ordering to the search results.

Parametersosid.resourcing.EffortSearchOrdereffortSearchOrder effort search order
ErrorsNULL_ARGUMENT effortSearchOrder is null
UNSUPPORTED effortSearchOrder is not of this service
Compliancemandatory This method must be implemented.
MethodgetEffortSearchRecord
Description

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

Parametersosid.type.TypeeffortSearchRecordType an effort search record type
Returnosid.resourcing.records.EffortSearchRecord the effort search record
ErrorsNULL_ARGUMENT effortSearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(effortSearchRecordType) is false
Compliancemandatory This method must be implemented.