public interface OrderQuerySession extends OsidSession
This session provides methods for searching Order
objects. The search query is constructed using the OrderQuery.
The item record Type
also specifies the record for
the item query.
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 |
---|---|
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.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getStoreId()
Store
Id
associated with this
session. Store Id
associated with this sessionmandatory
- This method must be implemented. Store getStore() throws OperationFailedException, PermissionDeniedException
Store
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canSearchOrders()
PERMISSION_DENIED.
This is intended as a hint to an
application that may not wish to offer search operations to
unauthorized users. false
if search methods are not authorized,
true
otherwisemandatory
- This method must be implemented. void useFederatedStoreView()
mandatory
- This method is must be implemented. void useIsolatedStoreView()
mandatory
- This method is must be implemented. OrderQuery getOrderQuery()
mandatory
- This method must be implemented. OrderList getOrdersByQuery(OrderQuery orderQuery) throws OperationFailedException, PermissionDeniedException
orderQuery
- the order query OrderList
NullArgumentException
- orderQuery
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- orderQuery
is not
of this servicemandatory
- This method must be implemented.