Interface StockSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface StockSearchResults
extends OsidSearchResults

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

Method Summary

Modifier and Type	Method	Description
StockQueryInspector	getStockQueryInspector()	Gets the inspector for the query to examine the terms used in the search.
StockList	getStocks()	Gets the stock list resulting from a search.
StockSearchResultsRecord	getStockSearchResultsRecord(Type stockSearchRecordType)	Gets the stock search results record corresponding to the given stock 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

getStocks

StockList getStocks()

Gets the stock list resulting from a search.

Returns:

the stock list

Throws:

IllegalStateException - the stock list has already been retrieved

Compliance:

mandatory - This method must be implemented.

getStockQueryInspector

StockQueryInspector getStockQueryInspector()

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

Returns:

the query inspector

Compliance:

mandatory - This method must be implemented.

getStockSearchResultsRecord

StockSearchResultsRecord getStockSearchResultsRecord(Type stockSearchRecordType)
                                              throws OperationFailedException

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

Parameters:

stockSearchRecordType - a stock search record type

Returns:

the stock search results record

Throws:

NullArgumentException - stockSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(stockSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.