Interface OrderSearchSession

All Superinterfaces:

AutoCloseable, Closeable, OrderQuerySession, OsidSession, 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

Modifier and Type	Method	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 Closeable

close

Methods inherited from interface OrderQuerySession

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

Modifier and Type	Method	Description
boolean	canSearchOrders()	Tests if this user can perform susbcription searches.
OrderQuery	getOrderQuery()	Gets an order query.
OrderList	getOrdersByQuery(OrderQuery orderQuery)	Gets a list of orders matching the given order query.
Store	getStore()	Gets the Store associated with this session.
Id	getStoreId()	Gets the Store Id associated with this session.
void	useFederatedStoreView()	Federates the view for methods in this session.
void	useIsolatedStoreView()	Isolates the view for methods in this session.

Methods inherited from interface OsidSession

close

Modifier and Type	Method	Description
void	close()	Close this session.

Methods inherited from interface OsidSession

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

Modifier and Type	Method	Description
Agent	getAuthenticatedAgent()	Gets the agent authenticated to this session.
Id	getAuthenticatedAgentId()	Gets the Id of the agent authenticated to this session.
BigDecimal	getClockRate()	Gets the rate of the service clock.
Date	getDate()	Gets the service date which may be the current date or the effective date in which this session exists.
Agent	getEffectiveAgent()	Gets the effective agent in use by this session.
Id	getEffectiveAgentId()	Gets the Id of the effective agent in use by this session.
Type	getFormatType()	Gets the DisplayText format Type preference in effect for this session.
Locale	getLocale()	Gets the locale indicating the localization preferences in effect for this session.
boolean	isAuthenticated()	Tests if an agent is authenticated to this session.
Transaction	startTransaction()	Starts a new transaction for this sesson.
boolean	supportsTransactions()	Tests for the availability of transactions.

Method Details

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.