OSID Logo
OSID Specifications
hold package
Version 3.1.0
Interfaceosid.hold.OublietteSearchResults
Implementsosid.OsidSearchResults
Used Byosid.hold.OublietteSearchSession
Description

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

MethodgetOubliettes
Description

Gets the oubliette list resulting from a search.

Returnosid.hold.OublietteList the oubliette list
ErrorsILLEGAL_STATE list already retrieved
Compliancemandatory This method must be implemented.
MethodgetOublietteQueryInspector
Description

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

Returnosid.hold.OublietteQueryInspector the oubliette query inspector
Compliancemandatory This 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.TypeoublietteSearchRecordType an oubliette search record type
Returnosid.hold.records.OublietteSearchResultsRecord the oubliette search results 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.