org.osid.ordering

Interface OrderSearchSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OrderQuerySession, OsidSession

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.

Method Summary

Methods

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.

Methods inherited from interface org.osid.ordering.OrderQuerySession

canSearchOrders, getOrderQuery, getOrdersByQuery, getStore, getStoreId, useFederatedStoreView, useIsolatedStoreView

Methods inherited from interface org.osid.OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

getOrderSearch

OrderSearch getOrderSearch()

Gets an order search.

Returns:

the order search

Compliance:

mandatory - This method must be implemented.

getOrderSearchOrder

OrderSearchOrder getOrderSearchOrder()

Gets an order search order. The OrderSearchOrder is supplied to an OrderSearch to specify the ordering of results.

Returns:

the order search order

Compliance:

mandatory - This method must be implemented.

getOrdersBySearch

OrderSearchResults getOrdersBySearch(OrderQuery orderQuery,
                                   OrderSearch orderSearch)
                                     throws OperationFailedException,
                                            PermissionDeniedException

Gets the search results matching the given search.

Parameters:

orderQuery - the order query

orderSearch - the order search

Returns:

the order search results

Throws:

NullArgumentException - orderQuery or orderSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - orderQuery or orderSearch is not of this service

Compliance:

mandatory - This method must be implemented.

getOrderQueryFromInspector

OrderQuery getOrderQueryFromInspector(OrderQueryInspector orderQueryInspector)

Gets an entry query from an inspector. The inspector is available from an OrderSearchResults.

Parameters:

orderQueryInspector - a query inspector

Returns:

the order query

Throws:

NullArgumentException - orderQueryInspector is null

UnsupportedException - orderQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.