public interface BranchSearchSession extends BranchQuerySession
This session provides methods for searching among Branch
objects. The search query is constructed using the BranchQuery.
getBranchsByQuery()
is the basic search method and
returns a list of Branches.
A more advanced search may be
performed with getBranchesBySearch().
It accepts an
BranchSearch
in addition to the query for the purpose of
specifying additional options affecting the entire search, such as
ordering. getBranchesBySearch()
returns an
BranchSearchResults
that can be used to access the resulting
BranchList
or be used to perform a search within the result
set through BranchList.
This session defines views that offer differing behaviors for searching.
Branches may have a query record indicated by their respective recod
types. The query record is accessed via the BranchQuery.
Modifier and Type | Method and Description |
---|---|
BranchSearchResults |
getBranchesBySearch(BranchQuery branchQuery,
BranchSearch branchSearch)
Gets the search results matching the given search query using the
given search.
|
BranchQuery |
getBranchQueryFromInspector(BranchQueryInspector branchQueryInspector)
Gets a branch query from an inspector.
|
BranchSearch |
getBranchSearch()
Gets a branch search.
|
BranchSearchOrder |
getBranchSearchOrder()
Gets a branch search order.
|
canSearchBranches, getBranchesByQuery, getBranchQuery, getJournal, getJournalId, useFederatedJournalView, useIsolatedJournalView
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
BranchSearch getBranchSearch()
mandatory
- This method must be implemented. BranchSearchOrder getBranchSearchOrder()
BranchSearchOrder
is
supplied to a BranchSearch
to specify the ordering of
results.mandatory
- This method must be implemented. BranchSearchResults getBranchesBySearch(BranchQuery branchQuery, BranchSearch branchSearch) throws OperationFailedException, PermissionDeniedException
branchQuery
- the branch querybranchSearch
- the branch searchNullArgumentException
- branchQuery
or
branchSearch
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- branchQuery
or
branchSearch
is not of this servicemandatory
- This method must be implemented. BranchQuery getBranchQueryFromInspector(BranchQueryInspector branchQueryInspector)
BranchSearchResults.
branchQueryInspector
- a branch query inspectorNullArgumentException
- branchQueryInspector
is null
UnsupportedException
- branchQueryInspector
is not of this servicemandatory
- This method must be implemented.