OSID Logo
OSID Specifications
hold package
Version 3.0.0
Release Candidate Preview
Interfaceosid.hold.OublietteSearchResults
Implementsosid.OsidSearchResults
Description

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

MethodgetOubliettes
Description

Gets the oubliette list resulting from a search.

Returnosid.hold.OublietteListthe oubliette list
ErrorsILLEGAL_STATElist already retrieved
CompliancemandatoryThis method must be implemented.
MethodgetOublietteQueryInspector
Description

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

Returnosid.hold.OublietteQueryInspectorthe oubliette query inspector
CompliancemandatoryThis method must be implemented.
MethodgetOublietteSearchResultsRecord
Description

Gets the oubliette search results 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.OublietteSearchResultsRecordthe oubliette search results 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.