public interface CommissionSearchSession extends CommissionQuerySession
This session provides methods for searching among Commission
objects. The search query is constructed using the
CommissionQuery.
getCommissionsByQuery()
is the basic search method and
returns a list of Commissions.
A more advanced search may
be performed with getCommissionsBySearch().
It accepts a
CommissionSearch
in addition to the query for the purpose
of specifying additional options affecting the entire search, such as
ordering. getCommissionsBySearch()
returns a
CommissionSearchResults
that can be used to access the resulting
CommissionList
or be used to perform a search within the
result set through CommissionSearch.
This session defines views that offer differing behaviors for searching.
Commissions may have a query record indicated by their respective
record types. The query record is accessed via the CommissionQuery.
Modifier and Type | Method and Description |
---|---|
CommissionQuery |
getCommissionQueryFromInspector(CommissionQueryInspector commissionQueryInspector)
Gets a commission query from an inspector.
|
CommissionSearchResults |
getCommissionsBySearch(CommissionQuery commissionQuery,
CommissionSearch commissionSearch)
Gets the search results matching the given search query using the
given search.
|
CommissionSearch |
getCommissionSearch()
Gets a commission search.
|
CommissionSearchOrder |
getCommissionSearchOrder()
Gets a commission search order.
|
canSearchCommissions, getCommissionQuery, getCommissionsByQuery, getFoundry, getFoundryId, useFederatedFoundryView, useIsolatedFoundryView
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
CommissionSearch getCommissionSearch()
mandatory
- This method must be implemented. CommissionSearchOrder getCommissionSearchOrder()
CommissionSearchOrder
is supplied to a CommissionSearch
to specify
the ordering of results.mandatory
- This method must be implemented. CommissionSearchResults getCommissionsBySearch(CommissionQuery commissionQuery, CommissionSearch commissionSearch) throws OperationFailedException, PermissionDeniedException
commissionQuery
- the commission querycommissionSearch
- the commission searchNullArgumentException
- commissionQuery
or commissionSearch
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- commissionQuery
or commissionSearch
is not of this servicemandatory
- This method must be implemented. CommissionQuery getCommissionQueryFromInspector(CommissionQueryInspector commissionQueryInspector)
CommissionSearchResults.
commissionQueryInspector
- a commission query inspectorNullArgumentException
- commissionQueryInspector
is null
UnsupportedException
- commissionQueryInspector
is not of this servicemandatory
- This method must be implemented.