public interface CustomerQuerySession extends OsidSession
This session provides methods for searching among Customer
objects. The search query is constructed using the
CustomerQuery.
This session defines views that offer differing behaviors for searching.
Customers may have a query record indicated by their respective record
types. The query record is accessed via the CustomerQuery.
Modifier and Type | Method and Description |
---|---|
boolean |
canSearchCustomers()
Tests if this user can perform
Customer searches. |
Business |
getBusiness()
Gets the
Business associated with this session. |
Id |
getBusinessId()
Gets the
Business Id associated with
this session. |
CustomerQuery |
getCustomerQuery()
Gets a customer query.
|
CustomerList |
getCustomersByQuery(CustomerQuery customerQuery)
Gets a list of
Customers matching the given customer
query. |
void |
useFederatedBusinessView()
Federates the view for methods in this session.
|
void |
useIsolatedBusinessView()
Isolates the view for methods in this session.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getBusinessId()
Business
Id
associated with
this session. Business Id
associated with this sessionmandatory
- This method must be implemented. Business getBusiness() throws OperationFailedException, PermissionDeniedException
Business
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canSearchCustomers()
Customer
searches. A
return of true does not guarantee successful authorization. A return
of false indicates that it is known all methods in this session will
result in a PERMISSION_DENIED.
This is intended as a
hint to an application that may opt not to offer search operations to
unauthorized users. false
if search methods are not authorized,
true
otherwisemandatory
- This method must be implemented. void useFederatedBusinessView()
mandatory
- This method is must be implemented. void useIsolatedBusinessView()
mandatory
- This method is must be implemented. CustomerQuery getCustomerQuery()
mandatory
- This method must be implemented. CustomerList getCustomersByQuery(CustomerQuery customerQuery) throws OperationFailedException, PermissionDeniedException
Customers
matching the given customer
query.customerQuery
- the customer query CustomerList
NullArgumentException
- customerQuery
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- customerQuery
is
not of this servicemandatory
- This method must be implemented.