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

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

MethodgetBlocks
Description

Gets the block list resulting from a search.

Returnosid.hold.BlockListthe block list
ErrorsILLEGAL_STATElist already retrieved
CompliancemandatoryThis method must be implemented.
MethodgetBlockQueryInspector
Description

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

Returnosid.hold.BlockQueryInspectorthe block query inspector
CompliancemandatoryThis method must be implemented.
MethodgetBlockSearchResultsRecord
Description

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

Parametersosid.type.TypeblockSearchRecordTypea block search record type
Returnosid.hold.records.BlockSearchResultsRecordthe block search results record
ErrorsNULL_ARGUMENT blockSearchRecordType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED hasRecordType(blockSearchRecordType) is false
CompliancemandatoryThis method must be implemented.