public interface CreditSearchSession extends CreditQuerySession
This session provides methods for searching Credit
objects. The search query is constructed using the CreditQuery.
The credit record Type also specifies the record
for the credit query.
getCreditsByQuery() is the basic search method and
returns a list of Credit elements. A more advanced search
may be performed with getCreditsBySearch(). It accepts a
CreditSearch in addition to the query for the purpose of
specifying additional options affecting the entire search, such as
ordering. getCreditsBySearch() returns a
CreditSearchResults that can be used to access the resulting
CreditList or be used to perform a search within the result
set through CreditSearch.
This session defines views that offer differing behaviors for searching.
Credits may have a query record indicated by their respective record
types. The query record is accessed via the CreditQuery.
The returns in this session may not be cast directly to these interfaces.
| Modifier and Type | Method and Description |
|---|---|
CreditQuery |
getCreditQueryFromInspector(CreditQueryInspector creditQueryInspector)
Gets a credit query from an inspector.
|
CreditSearchResults |
getCreditsBySearch(CreditQuery creditQuery,
CreditSearch creditSearch)
Gets the search results matching the given search.
|
CreditSearch |
getCreditSearch()
Gets a credit search.
|
CreditSearchOrder |
getCreditSearchOrder()
Gets a credit search order.
|
canSearchCredits, getBilling, getBillingId, getCreditQuery, getCreditsByQuery, useFederatedBillingView, useIsolatedBillingViewgetAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactionscloseCreditSearch getCreditSearch()
mandatory - This method must be implemented. CreditSearchOrder getCreditSearchOrder()
CreditSearchOrder is
supplied to a CreditSearch to specify the ordering of
results.mandatory - This method must be implemented. CreditSearchResults getCreditsBySearch(CreditQuery creditQuery, CreditSearch creditSearch) throws OperationFailedException, PermissionDeniedException
creditQuery - the credit querycreditSearch - the credit searchNullArgumentException - creditQuery or
creditSearch is null OperationFailedException - unable to complete requestPermissionDeniedException - authorization failureUnsupportedException - creditQuery or
creditSearch is not of this servicemandatory - This method must be implemented. CreditQuery getCreditQueryFromInspector(CreditQueryInspector creditQueryInspector)
CreditSearchResults. creditQueryInspector - a credit query inspectorNullArgumentException - creditQueryInspector
is null UnsupportedException - creditQueryInspector
is not of this servicemandatory - This method must be implemented.