public interface OrderSearchSession extends OrderQuerySession
This session provides methods for searching Order
objects. The search query is constructed using the OrderQuery.
The order record Type
also specifies the record for
the order query.
getOrdersByQuery()
is the basic search method and
returns a list of Order
elements. A more advanced search
may be performed with getOrdersBySearch().
It accepts an
OrderSearch
in addition to the query for the purpose of
specifying additional options affecting the entire search, such as
ordering. getOrdersBySearch()
returns an
OrderSearchResults
that can be used to access the resulting
OrderList
or be used to perform a search within the result set
through OrderSearch.
Orders may have a query record indicated by their respective record
types. The query record is accessed via the OrderQuery.
The
returns in this session may not be cast directly to these interfaces.
Modifier and Type | Method and Description |
---|---|
OrderQuery |
getOrderQueryFromInspector(OrderQueryInspector orderQueryInspector)
Gets an entry query from an inspector.
|
OrderSearchResults |
getOrdersBySearch(OrderQuery orderQuery,
OrderSearch orderSearch)
Gets the search results matching the given search.
|
OrderSearch |
getOrderSearch()
Gets an order search.
|
OrderSearchOrder |
getOrderSearchOrder()
Gets an order search order.
|
canSearchOrders, getOrderQuery, getOrdersByQuery, getStore, getStoreId, useFederatedStoreView, useIsolatedStoreView
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
OrderSearch getOrderSearch()
mandatory
- This method must be implemented. OrderSearchOrder getOrderSearchOrder()
OrderSearchOrder
is
supplied to an OrderSearch
to specify the ordering of
results.mandatory
- This method must be implemented. OrderSearchResults getOrdersBySearch(OrderQuery orderQuery, OrderSearch orderSearch) throws OperationFailedException, PermissionDeniedException
orderQuery
- the order queryorderSearch
- the order searchNullArgumentException
- orderQuery
or
orderSearch
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- orderQuery
or
orderSearch
is not of this servicemandatory
- This method must be implemented. OrderQuery getOrderQueryFromInspector(OrderQueryInspector orderQueryInspector)
OrderSearchResults.
orderQueryInspector
- a query inspectorNullArgumentException
- orderQueryInspector
is null
UnsupportedException
- orderQueryInspector
is not of this servicemandatory
- This method must be implemented.