public interface BudgetSearchSession extends BudgetQuerySession
This session provides methods for searching among Budget
objects. The search query is constructed using the BudgetQuery.
getBudgetsByQuery()
is the basic search method and
returns a list of Budgets.
A more advanced search may be
performed with getBudgetsBySearch().
It accepts a
BudgetSearch
in addition to the query for the purpose of
specifying additional options affecting the entire search, such as
ordering. getBudgetsBySearch()
returns a
BudgetSearchResults
that can be used to access the resulting
BudgetList
or be used to perform a search within the result
set through BudgetSearch.
This session defines views that offer differing behaviors for searching.
Budgets may have a query record indicated by their respective record
types. The queryrecord is accessed via the BudgetQuery.
Modifier and Type | Method and Description |
---|---|
BudgetQuery |
getBudgetQueryFromInspector(ItemQueryInspector budgetQueryInspector)
Gets a budget query from an inspector.
|
BudgetSearchResults |
getBudgetsBySearch(BudgetQuery budgetQuery,
BudgetSearch budgetSearch)
Gets the search results matching the given search query using the
given search.
|
BudgetSearch |
getBudgetSearch()
Gets a budget search.
|
BudgetSearchOrder |
getBudgetSearchOrder()
Gets a budget search order.
|
canSearchBudgets, getBudgetQuery, getBudgetsByQuery, getBusiness, getBusinessId, useFederatedBusinessView, useIsolatedBusinessView
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
BudgetSearch getBudgetSearch()
mandatory
- This method must be implemented. BudgetSearchOrder getBudgetSearchOrder()
BudgetSearchOrder
is
supplied to a BudgetSearch
to specify the ordering of
results.mandatory
- This method must be implemented. BudgetSearchResults getBudgetsBySearch(BudgetQuery budgetQuery, BudgetSearch budgetSearch) throws OperationFailedException, PermissionDeniedException
budgetQuery
- the budget querybudgetSearch
- the budget searchNullArgumentException
- budgetQuery
or
budgetSearch
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- budgetQuery
or
budgetSearch
is not of this servicemandatory
- This method must be implemented. BudgetQuery getBudgetQueryFromInspector(ItemQueryInspector budgetQueryInspector)
BudgetSearchResults.
budgetQueryInspector
- a budget query inspectorNullArgumentException
- budgetQueryInspector
is null
UnsupportedException
- budgetQueryInspector
is not of this servicemandatory
- This method must be implemented.