OSID Logo
OSID Specifications
configuration package
Version 3.0.0
Release Candidate Preview
Interfaceosid.configuration.ValueSearch
Implementsosid.OsidSearch
Description

The interface for governing value searches.

MethodsearchAmongValues
Description

Executes this search among a given list of values.

Parametersosid.id.IdListvalueIdslist of values
ErrorsNULL_ARGUMENT valueIds is null
CompliancemandatoryThis method must be implemented.
MethodorderValueResults
Description

Specify an ordering to the search results.

Parametersosid.configuration.ValueSearchOrdervalueSearchOrdervalue search order
ErrorsNULL_ARGUMENT valueSearchOrder is null
UNSUPPORTED valueSearchOrder is not of this service
CompliancemandatoryThis 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.TypevalueSearchRecordTypea value search record type
Returnosid.configuration.records.ValueSearchRecordthe value search record
ErrorsNULL_ARGUMENT valueSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(valueSearchRecordType) is false
CompliancemandatoryThis method must be implemented.