public interface AccountQuerySession extends OsidSession
This session provides methods for searching among Account
objects. The search query is constructed using the
AccountQuery.
This session defines views that offer differing behaviors for searching.
Accounts may have a query record indicated by their respective record
types. The query record is accessed via the AccountQuery.
Modifier and Type | Method and Description |
---|---|
boolean |
canSearchAccounts()
Tests if this user can perform
Account lookups. |
AccountQuery |
getAccountQuery()
Gets an account query.
|
AccountList |
getAccountsByQuery(AccountQuery accountsQuery)
Gets a list of
Accounts matching the given account
query. |
Business |
getBusiness()
Gets the
Business associated with this session. |
Id |
getBusinessId()
Gets the
Business Id associated with
this session. |
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 canSearchAccounts()
Account
lookups. 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 not offer lookup 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. AccountQuery getAccountQuery()
mandatory
- This method must be implemented. AccountList getAccountsByQuery(AccountQuery accountsQuery) throws OperationFailedException, PermissionDeniedException
Accounts
matching the given account
query.accountsQuery
- the account query AccountList
NullArgumentException
- accountQuery
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- accountQuery
is
not of this servicemandatory
- This method must be implemented.