Interface OrderSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface OrderSearch
extends OsidSearch

The search interface for governing order searches.

Method Summary

Modifier and Type	Method	Description
OrderSearchRecord	getOrderSearchRecord(Type orderSearchRecordType)	Gets the order record corresponding to the given order search record Type.
void	orderOrderResults(OrderSearchOrder orderSearchOrder)	Specify an ordering to the search results.
void	searchAmongOrders(IdList orderIds)	Execute this search among the given list of orders.

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

searchAmongOrders

void searchAmongOrders(IdList orderIds)

Execute this search among the given list of orders.

Parameters:

orderIds - list of orders

Throws:

NullArgumentException - orderIds is null

Compliance:

mandatory - This method must be implemented.

orderOrderResults

void orderOrderResults(OrderSearchOrder orderSearchOrder)

Specify an ordering to the search results.

Parameters:

orderSearchOrder - order search order

Throws:

NullArgumentException - orderSearchOrder is null

UnsupportedException - orderSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getOrderSearchRecord

OrderSearchRecord getOrderSearchRecord(Type orderSearchRecordType)
                                throws OperationFailedException

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

Parameters:

orderSearchRecordType - an order search record type

Returns:

the order search record

Throws:

NullArgumentException - orderSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(orderSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.