OSID Logo
OSID Specifications
configuration package
Version 3.1.0
Interfaceosid.configuration.ValueSearch
Implementsosid.OsidSearch
Used Byosid.configuration.ValueSearchSession
Description

The interface for governing value searches.

MethodsearchAmongValues
Description

Executes this search among a given list of values.

Parametersosid.id.IdListvalueIds list of values
ErrorsNULL_ARGUMENT valueIds is null
Compliancemandatory This method must be implemented.
MethodorderValueResults
Description

Specify an ordering to the search results.

Parametersosid.configuration.ValueSearchOrdervalueSearchOrder value search order
ErrorsNULL_ARGUMENT valueSearchOrder is null
UNSUPPORTED valueSearchOrder is not of this service
Compliancemandatory This method must be implemented.
MethodgetValueSearchRecord
Description

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

Parametersosid.type.TypevalueSearchRecordType a value search record type
Returnosid.configuration.records.ValueSearchRecord the value search record
ErrorsNULL_ARGUMENT valueSearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(valueSearchRecordType) is false
Compliancemandatory This method must be implemented.