Interface BlockSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface BlockSearch
extends OsidSearch

The search interface for governing block searches.

Method Summary

Modifier and Type	Method	Description
BlockSearchRecord	getBlockSearchRecord(Type blockSearchRecordType)	Gets the block search record corresponding to the given block search record Type .
void	orderBlockResults(BlockSearchOrder blockSearchOrder)	Specify an ordering to the search results.
void	searchAmongBlocks(IdList blockIds)	Execute this search among the given list of blocks.

Methods inherited from interface Extensible

getRecordTypes, hasRecordType

Modifier and Type	Method	Description
TypeList	getRecordTypes()	Gets the record types available in this object.
boolean	hasRecordType(Type recordType)	Tests if this object supports the given record Type .

Methods inherited from interface OsidSearch

limitResultSet

Modifier and Type	Method	Description
void	limitResultSet(long start, long end)	By default, searches return all matching results.

Method Details

searchAmongBlocks

void searchAmongBlocks(IdList blockIds)

Execute this search among the given list of blocks.

Parameters:

blockIds - list of blocks

Throws:

NullArgumentException - blockIds is null

Compliance:

mandatory - This method must be implemented.

orderBlockResults

void orderBlockResults(BlockSearchOrder blockSearchOrder)

Specify an ordering to the search results.

Parameters:

blockSearchOrder - block search order

Throws:

NullArgumentException - blockSearchOrder is null

UnsupportedException - blockSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getBlockSearchRecord

BlockSearchRecord getBlockSearchRecord(Type blockSearchRecordType)
                                throws OperationFailedException,
PermissionDeniedException

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.

Parameters:

blockSearchRecordType - a block search record type

Returns:

the block search record

Throws:

NullArgumentException - blockSearchRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - hasRecordType(blockSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.