public interface FunctionSearchSession extends FunctionQuerySession
This session provides methods for searching Function
objects. The search query is constructed using the FunctionQuery.
The function record Type
also specifies the record
for the function query.
getFunctionsByQuery()
is the basic search method and
returns a list of Functions.
A more advanced search may be
performed with getFunctionsBySearch().
It accepts a
FunctionSearch
in addition to the query for the purpose of
specifying additional options affecting the entire search, such as
ordering. getFunctionsBySearch()
returns an
FunctionSearchResults
that can be used to access the resulting
FunctionList
or be used to perform a search within the
result set through FunctionSearch.
This session defines views that offer differing behaviors for searching.
Functions may have a query record indicated by their respective record
types. The query record is accessed via the FunctionQuery.
Modifier and Type | Method and Description |
---|---|
FunctionQuery |
getFunctionQueryFromInspector(FunctionQueryInspector functionQueryInspector)
Gets a function query from an inspector.
|
FunctionSearchResults |
getFunctionsBySearch(FunctionQuery functionQuery,
FunctionSearch functionSearch)
Gets the search results matching the given search query using the
given search.
|
FunctionSearch |
getFunctionSearch()
Gets a function search.
|
FunctionSearchOrder |
getFunctionSearchOrder()
Gets a function search order.
|
canSearchFunctions, getFunctionQuery, getFunctionsByQuery, getVault, getVaultId, useFederatedVaultView, useIsolatedVaultView
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
FunctionSearch getFunctionSearch()
mandatory
- This method must be implemented. FunctionSearchOrder getFunctionSearchOrder()
FunctionSearchOrder
is supplied to a FunctionSearch
to specify the ordering
of results.mandatory
- This method must be implemented. FunctionSearchResults getFunctionsBySearch(FunctionQuery functionQuery, FunctionSearch functionSearch) throws OperationFailedException, PermissionDeniedException
functionQuery
- the function queryfunctionSearch
- the function searchNullArgumentException
- functionQuery
or
functionSearch
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- functionSearch
or
functionQuery
is not of this servicemandatory
- This method must be implemented. FunctionQuery getFunctionQueryFromInspector(FunctionQueryInspector functionQueryInspector)
FunctionSearchResults.
functionQueryInspector
- a function query inspectorNullArgumentException
- functionQueryInspector
is null
UnsupportedException
- functionQueryInspector
is not of this servicemandatory
- This method must be implemented.