public interface AccountSearchSession extends AccountQuerySession
This session provides methods for searching among Account
objects. The search query is constructed using the
AccountQuery.
getAccountsByQuery()
is the basic search method and
returns a list of Accounts.
A more advanced search may be
performed with getAccountsBySearch().
It accepts an
AccountSearch
in addition to the query for the purpose of
specifying additional options affecting the entire search, such as
ordering. getAccountsBySearch()
returns an
AccountSearchResults
that can be used to access the resulting
AccountList
or be used to perform a search within the
result set through AccountSearch.
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 |
---|---|
AccountQuery |
getAccountQueryFromInspector(ItemQueryInspector accountQueryInspector)
Gets an account query from an inspector.
|
AccountSearchResults |
getAccountsBySearch(AccountQuery accountQuery,
AccountSearch accountSearch)
Gets the search results matching the given search query using the
given search.
|
AccountSearch |
getAccountSearch()
Gets an account search.
|
AccountSearchOrder |
getAccountSearchOrder()
Gets an activity search order.
|
canSearchAccounts, getAccountQuery, getAccountsByQuery, getBusiness, getBusinessId, useFederatedBusinessView, useIsolatedBusinessView
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
AccountSearch getAccountSearch()
mandatory
- This method must be implemented. AccountSearchOrder getAccountSearchOrder()
AccountSearchOrder
is supplied to an AccountSearch
to specify the ordering
of results.mandatory
- This method must be implemented. AccountSearchResults getAccountsBySearch(AccountQuery accountQuery, AccountSearch accountSearch) throws OperationFailedException, PermissionDeniedException
accountQuery
- the account queryaccountSearch
- the account searchNullArgumentException
- accountQuery
or
accountSearch
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- accountQuery
or
accountSearch
is not of this servicemandatory
- This method must be implemented. AccountQuery getAccountQueryFromInspector(ItemQueryInspector accountQueryInspector)
AccountSearchResults.
accountQueryInspector
- an account query inspectorNullArgumentException
- accountQueryInspector
is null
UnsupportedException
- accountQueryInspector
is not of this servicemandatory
- This method must be implemented.