public interface OrderSearch extends OsidSearch
The search interface for governing order searches.
Modifier and Type | Method and 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.
|
limitResultSet
getRecordTypes, hasRecordType
void searchAmongOrders(IdList orderIds)
orderIds
- list of ordersNullArgumentException
- orderIds
is
null
mandatory
- This method must be implemented. void orderOrderResults(OrderSearchOrder orderSearchOrder)
orderSearchOrder
- order search orderNullArgumentException
- orderSearchOrder
is null
UnsupportedException
- orderSearchOrder
is not of this servicemandatory
- This method must be implemented. OrderSearchRecord getOrderSearchRecord(Type orderSearchRecordType) throws OperationFailedException
Type.
This method is used to retrieve an object
implementing the requested record.orderSearchRecordType
- a order search record typeNullArgumentException
- orderSearchRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(orderSearchRecordType)
is false
mandatory
- This method must be implemented.