OSID Logo
OSID Specifications
hold package
Version 3.1.0
Interfaceosid.hold.OublietteSearch
Implementsosid.OsidSearch
Used Byosid.hold.OublietteSearchSession
Description

The search interface for governing oubliette searches.

MethodsearchAmongOubliettes
Description

Execute this search among the given list of oubliettes.

Parametersosid.id.IdListoublietteIds list of oubliettes
ErrorsNULL_ARGUMENT oublietteIds is null
Compliancemandatory This method must be implemented.
MethodorderOublietteResults
Description

Specify an ordering to the search results.

Parametersosid.hold.OublietteSearchOrderoublietteSearchOrder oubliette search order
ErrorsNULL_ARGUMENT oublietteSearchOrder is null
UNSUPPORTED oublietteSearchOrder is not of this service
Compliancemandatory This method must be implemented.
MethodgetOublietteSearchRecord
Description

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

Parametersosid.type.TypeoublietteSearchRecordType an oubliette search record type
Returnosid.hold.records.OublietteSearchRecord the oubliette search record
ErrorsNULL_ARGUMENT oublietteSearchRecordType is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure occurred
UNSUPPORTED hasRecordType(oublietteSearchRecordType) is false
Compliancemandatory This method must be implemented.