public interface CustomerSmartBusinessSession extends OsidSession
This session manages queries and sequencing to create "smart" dynamic
catalogs. A CustomerQuery
can be retrieved from this
session and mapped to this Business
to create a virtual
collection of Customers.
The customers may be sequenced
using the CustomerSearchOrder
from this session.
This Business
has a default query that matches any
customer and a default search order that specifies no sequencing. The
queries may be examined using a CustomerQueryInspector.
The
query may be modified by converting the inspector back to a
CustomerQuery.
Modifier and Type | Method and Description |
---|---|
void |
applyCustomerQuery(CustomerQuery customerQuery)
Applies a customer query to this business.
|
void |
applyCustomerSequencing(CustomerSearchOrder customerSearchOrder)
Applies a customer search order to this business.
|
boolean |
canManageSmartBusinesses()
Tests if this user can manage smart businesses.
|
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.
|
CustomerQuery |
getCustomerQueryFromInspector(CustomerQueryInspector customerQueryInspector)
Gets a customer query from an inspector.
|
CustomerSearchOrder |
getCustomerSearchOrder()
Gets a customer search order.
|
CustomerQueryInspector |
inspectCustomerQuery()
Gets a customer query inspector for this business.
|
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 canManageSmartBusinesses()
PERMISSION_DENIED.
This is intended as a hint to an
application that may opt not to offer operations to unauthorized
users. false
if smart business management is not
authorized, true
otherwisemandatory
- This method must be implemented. CustomerQuery getCustomerQuery()
mandatory
- This method must be implemented. CustomerSearchOrder getCustomerSearchOrder()
mandatory
- This method must be implemented. void applyCustomerQuery(CustomerQuery customerQuery) throws OperationFailedException, PermissionDeniedException
customerQuery
- the customer queryNullArgumentException
- customerQuery
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- customerQuery
not
of this servicemandatory
- This method must be implemented. CustomerQueryInspector inspectCustomerQuery() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. void applyCustomerSequencing(CustomerSearchOrder customerSearchOrder) throws OperationFailedException, PermissionDeniedException
customerSearchOrder
- the customer search orderNullArgumentException
- customerSearchOrder
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- customerSearchOrder
not of this servicemandatory
- This method must be implemented. CustomerQuery getCustomerQueryFromInspector(CustomerQueryInspector customerQueryInspector)
customerQueryInspector
- a query inspectorNullArgumentException
- customerQueryInspector
is null
UnsupportedException
- customerQueryInspector
is not of this servicemandatory
- This method must be implemented.