OSID Logo
OSID Specifications
hold package
Version 3.1.0
Interfaceosid.hold.BlockSearchResults
Implementsosid.OsidSearchResults
Used Byosid.hold.BlockSearchSession
Description

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

MethodgetBlocks
Description

Gets the block list resulting from a search.

Returnosid.hold.BlockList the block list
ErrorsILLEGAL_STATE list already retrieved
Compliancemandatory This method must be implemented.
MethodgetBlockQueryInspector
Description

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

Returnosid.hold.BlockQueryInspector the block query inspector
Compliancemandatory This 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.TypeblockSearchRecordType a block search record type
Returnosid.hold.records.BlockSearchResultsRecord the block search results record
ErrorsNULL_ARGUMENT blockSearchRecordType is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure occurred
UNSUPPORTED hasRecordType(blockSearchRecordType) is false
Compliancemandatory This method must be implemented.