public interface AccountSmartBusinessSession extends OsidSession
This session manages queries and sequencing to create "smart" dynamic
catalogs. An AccountQuery
can be retrieved from this
session and mapped to this Business
to create a virtual
collection of Accounts.
The accounts may be sequenced using
the AccountSearchOrder
from this session.
This Business
has a default query that matches any
account and a default search order that specifies no sequencing. The
queries may be examined using an AccountQueryInspector.
The
query may be modified by converting the inspector back to an
AccountQuery.
Modifier and Type | Method and Description |
---|---|
void |
applyAccountQuery(AccountQuery accountQuery)
Applies an account query to this business.
|
void |
applyAccountSequencing(AccountSearchOrder accountSearchOrder)
Applies an account search order to this business.
|
boolean |
canManageSmartBusinesses()
Tests if this user can manage smart businesses.
|
AccountQuery |
getAccountQuery()
Gets an account query.
|
AccountQuery |
getAccountQueryFromInspector(AccountQueryInspector accountQueryInspector)
Gets an account query from an inspector.
|
AccountSearchOrder |
getAccountSearchOrder()
Gets an account search order.
|
Business |
getBusiness()
Gets the
Business associated with this session. |
Id |
getBusinessId()
Gets the
Business Id associated with
this session. |
AccountQueryInspector |
inspectAccountQuery()
Gets an account 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. AccountQuery getAccountQuery()
mandatory
- This method must be implemented. AccountSearchOrder getAccountSearchOrder()
mandatory
- This method must be implemented. void applyAccountQuery(AccountQuery accountQuery) throws OperationFailedException, PermissionDeniedException
accountQuery
- the account queryNullArgumentException
- accountQuery
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- accountQuery
not
of this servicemandatory
- This method must be implemented. AccountQueryInspector inspectAccountQuery() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. void applyAccountSequencing(AccountSearchOrder accountSearchOrder) throws OperationFailedException, PermissionDeniedException
accountSearchOrder
- the account search orderNullArgumentException
- accountSearchOrder
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- accountSearchOrder
not of this servicemandatory
- This method must be implemented. AccountQuery getAccountQueryFromInspector(AccountQueryInspector accountQueryInspector)
accountQueryInspector
- a query inspectorNullArgumentException
- accountQueryInspector
is null
UnsupportedException
- accountQueryInspector
is not of this servicemandatory
- This method must be implemented.