OSID Logo
OSID Specifications
hold package
Version 3.0.0
Release Candidate Preview
Interfaceosid.hold.OublietteSearch
Implementsosid.OsidSearch
Description

The search interface for governing oubliette searches.

MethodsearchAmongOubliettes
Description

Execute this search among the given list of oubliettes.

Parametersosid.id.IdListoublietteIdslist of oubliettes
ErrorsNULL_ARGUMENT oublietteIds is null
CompliancemandatoryThis method must be implemented.
MethodorderOublietteResults
Description

Specify an ordering to the search results.

Parametersosid.hold.OublietteSearchOrderoublietteSearchOrderoubliette search order
ErrorsNULL_ARGUMENT oublietteSearchOrder is null
UNSUPPORTED oublietteSearchOrder is not of this service
CompliancemandatoryThis 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.TypeoublietteSearchRecordTypean oubliette search record type
Returnosid.hold.records.OublietteSearchRecordthe oubliette search record
ErrorsNULL_ARGUMENT oublietteSearchRecordType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED hasRecordType(oublietteSearchRecordType) is false
CompliancemandatoryThis method must be implemented.