public interface BudgetEntrySearchSession extends BudgetEntryQuerySession
This session provides methods for searching among BudgetEntry
objects. The search query is constructed using the
BudgetEntryQuery.
getBudgetEntriesByQuery()
is the basic search method
and returns a list of BudgetEntrys.
A more advanced search
may be performed with getBudgetEntrysBySearch().
It accepts
an BudgetEntrySearch
in addition to the query for the
purpose of specifying additional options affecting the entire search, such
as ordering. getBudgetEntriesBySearch()
returns an
BudgetEntrySearchResults
that can be used to access the resulting
BudgetEntryList
or be used to perform a search within the
result set through BudgetEntrySearch.
This session defines views that offer differing behaviors for searching.
BudgetBudget Entries may have a query record indicated by their
respective record types. The query record is accessed via the
BudgetEntryQuery.
Modifier and Type | Method and Description |
---|---|
BudgetEntrySearchResults |
getBudgetEntriesBySearch(BudgetEntryQuery budgetEntryQuery,
BudgetEntrySearch budgetEntrySearch)
Gets the search results matching the given search query using the
given search.
|
BudgetEntryQuery |
getBudgetEntryQueryFromInspector(BudgetEntryQueryInspector budgetEntryQueryInspector)
Gets a budget entry query from an inspector.
|
BudgetEntrySearch |
getBudgetEntrySearch()
Gets a budget entry search.
|
BudgetEntrySearchOrder |
getBudgetEntrySearchOrder()
Gets a budget entry search order.
|
canSearchBudgetEntries, getBudgetEntriesByQuery, getBudgetEntryQuery, getBusiness, getBusinessId, useFederatedBusinessView, useIsolatedBusinessView
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
BudgetEntrySearch getBudgetEntrySearch()
mandatory
- This method must be implemented. BudgetEntrySearchOrder getBudgetEntrySearchOrder()
BudgetEntrySearchOrder
is supplied to an BudgetEntrySearch
to specify
the ordering of results.mandatory
- This method must be implemented. BudgetEntrySearchResults getBudgetEntriesBySearch(BudgetEntryQuery budgetEntryQuery, BudgetEntrySearch budgetEntrySearch) throws OperationFailedException, PermissionDeniedException
budgetEntryQuery
- the budget entry querybudgetEntrySearch
- the budget entry searchNullArgumentException
- budgetEntryQuery
or budgetEntrySearch
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- budgetEntryQuery
or budgetEntrySearch
is not of this servicemandatory
- This method must be implemented. BudgetEntryQuery getBudgetEntryQueryFromInspector(BudgetEntryQueryInspector budgetEntryQueryInspector)
BudgetEntrySearchResults.
budgetEntryQueryInspector
- a budget entry query inspectorNullArgumentException
-
budgetEntryQueryInspector
is null
UnsupportedException
- budgetEntryQueryInspector
is not of this servicemandatory
- This method must be implemented.