OSID Logo
OSID Specifications
resourcing package
Version 3.1.0
Interfaceosid.resourcing.EffortSearchResults
Implementsosid.OsidSearchResults
Used Byosid.resourcing.EffortSearchSession
Description

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

MethodgetEfforts
Description

Gets the effort list resulting from a search.

Returnosid.resourcing.EffortList the effort list
ErrorsILLEGAL_STATE list already retrieved
Compliancemandatory This method must be implemented.
MethodgetEffortQueryInspector
Description

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

Returnosid.resourcing.EffortQueryInspector the effort query inspector
Compliancemandatory This method must be implemented.
MethodgetEffortSearchResultsRecord
Description

Gets the effort search results 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.EffortSearchResultsRecord the effort search results record
ErrorsNULL_ARGUMENT effortSearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(effortSearchRecordType) is false
Compliancemandatory This method must be implemented.