Interface StockSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface StockSearch
extends OsidSearch

The search interface for governing stock searches.

Method Summary

Modifier and Type	Method	Description
StockSearchRecord	getStockSearchRecord(Type stockSearchRecordType)	Gets the stock search record corresponding to the given stock search record Type.
void	orderStockResults(StockSearchOrder stockSearchOrder)	Specify an ordering to the search results.
void	searchAmongStocks(IdList stockIds)	Execute this search among the given list of stocks.

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

searchAmongStocks

void searchAmongStocks(IdList stockIds)

Execute this search among the given list of stocks.

Parameters:

stockIds - list of stocks

Throws:

NullArgumentException - stockIds is null

Compliance:

mandatory - This method must be implemented.

orderStockResults

void orderStockResults(StockSearchOrder stockSearchOrder)

Specify an ordering to the search results.

Parameters:

stockSearchOrder - stock search order

Throws:

NullArgumentException - stockSearchOrder is null

UnsupportedException - stockSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getStockSearchRecord

StockSearchRecord getStockSearchRecord(Type stockSearchRecordType)
                                throws OperationFailedException

Gets the stock search 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 record

Throws:

NullArgumentException - stockSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(stockSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.