OSID Logo
OSID Specifications
hold package
Version 3.1.0
Interfaceosid.hold.BlockSearch
Implementsosid.OsidSearch
Used Byosid.hold.BlockSearchSession
Description

The search interface for governing block searches.

MethodsearchAmongBlocks
Description

Execute this search among the given list of blocks.

Parametersosid.id.IdListblockIds list of blocks
ErrorsNULL_ARGUMENT blockIds is null
Compliancemandatory This method must be implemented.
MethodorderBlockResults
Description

Specify an ordering to the search results.

Parametersosid.hold.BlockSearchOrderblockSearchOrder block search order
ErrorsNULL_ARGUMENT blockSearchOrder is null
UNSUPPORTED blockSearchOrder is not of this service
Compliancemandatory This method must be implemented.
MethodgetBlockSearchRecord
Description

Gets the block search 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.BlockSearchRecord the block search 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.