OSID Logo
OSID Specifications
resourcing package
Version 3.0.0
Release Candidate Preview
Interfaceosid.resourcing.EffortSearch
Implementsosid.OsidSearch
Description

The search interface for governing effort searches.

MethodsearchAmongEfforts
Description

Execute this search among the given list of efforts.

Parametersosid.id.IdListeffortIdslist of efforts
ErrorsNULL_ARGUMENT effortIds is null
CompliancemandatoryThis method must be implemented.
MethodorderEffortResults
Description

Specify an ordering to the search results.

Parametersosid.resourcing.EffortSearchOrdereffortSearchOrdereffort search order
ErrorsNULL_ARGUMENT effortSearchOrder is null
UNSUPPORTED effortSearchOrder is not of this service
CompliancemandatoryThis 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.TypeeffortSearchRecordTypean effort search record type
Returnosid.resourcing.records.EffortSearchRecordthe effort search record
ErrorsNULL_ARGUMENT effortSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(effortSearchRecordType) is false
CompliancemandatoryThis method must be implemented.