Interface ChainSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface ChainSearchResults
extends OsidSearchResults

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

Method Summary

Modifier and Type	Method	Description
ChainQueryInspector	getChainQueryInspector()	Gets the inspector for the query to examine the terms used in the search.
ChainList	getChains()	Gets the chain list resulting from a search.
ChainSearchResultsRecord	getChainSearchResultsRecord(Type chainSearchRecordType)	Gets the chain search results record corresponding to the given chain 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

getChains

ChainList getChains()

Gets the chain list resulting from a search.

Returns:

the chain list

Throws:

IllegalStateException - list already retrieved

Compliance:

mandatory - This method must be implemented.

getChainQueryInspector

ChainQueryInspector getChainQueryInspector()

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

Returns:

the chain query inspector

Compliance:

mandatory - This method must be implemented.

getChainSearchResultsRecord

ChainSearchResultsRecord getChainSearchResultsRecord(Type chainSearchRecordType)
                                              throws OperationFailedException

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

Parameters:

chainSearchRecordType - a chain search record type

Returns:

the chain search results record

Throws:

NullArgumentException - chainSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(chainSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.