Interface BlockSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface BlockSearchResults
extends OsidSearchResults

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

Method Summary

Modifier and Type	Method	Description
BlockQueryInspector	getBlockQueryInspector()	Gets the inspector for the query to examine the terms used in the search.
BlockList	getBlocks()	Gets the block list resulting from a search.
BlockSearchResultsRecord	getBlockSearchResultsRecord(Type blockSearchRecordType)	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.

Methods inherited from interface Browsable

getProperties, getPropertiesByRecordType

Modifier and Type	Method	Description
PropertyList	getProperties()	Gets a list of properties.
PropertyList	getPropertiesByRecordType(Type recordType)	Gets a list of properties corresponding to the specified record type.

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 OsidSearchResults

getResultSize

Modifier and Type	Method	Description
long	getResultSize()	Returns the size of a result set from a search query.

Method Details

getBlocks

BlockList getBlocks()

Gets the block list resulting from a search.

Returns:

the block list

Throws:

IllegalStateException - list already retrieved

Compliance:

mandatory - This method must be implemented.

getBlockQueryInspector

BlockQueryInspector getBlockQueryInspector()

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

Returns:

the block query inspector

Compliance:

mandatory - This method must be implemented.

getBlockSearchResultsRecord

BlockSearchResultsRecord getBlockSearchResultsRecord(Type blockSearchRecordType)
                                              throws OperationFailedException,
PermissionDeniedException

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.

Parameters:

blockSearchRecordType - a block search record type

Returns:

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