public interface ObjectiveBankSearchSession extends ObjectiveBankQuerySession
This session provides methods for searching among ObjectiveBank
objects. The search query is constructed using the
ObjectiveBankQuery.
getObjectiveBanksByQuery()
is the basic search method
and returns a list of ObjectiveBank
objects.A more advanced
search may be performed with getObjectiveBanksBySearch().
It accepts a ObjectiveBankSearch
in addition to the query
for the purpose of specifying additional options affecting the entire
search, such as ordering. getObjectiveBanksBySearch()
returns a ObjectiveBankSearchResults
that can be used to
access the resulting ObjectiveBankList
or be used to
perform a search within the result set through ObjectiveBankSearch.
ObjectiveBanks
may have a query record indicated by
their respective record types. The query record is accessed via the
ObjectiveBankQuery.
Modifier and Type | Method and Description |
---|---|
ObjectiveBankQuery |
getObjectiveBankQueryFromInspector(ObjectiveBankQueryInspector objectiveBankQueryInspector)
Gets an objective bank query from an inspector.
|
ObjectiveBankSearchResults |
getObjectiveBanksBySearch(ObjectiveBankQuery objectiveBankQuery,
ObjectiveBankSearch objectiveBankSearch)
Gets the search results matching the given search query using the
given search.
|
ObjectiveBankSearch |
getObjectiveBankSearch()
Gets an objective bank search.
|
ObjectiveBankSearchOrder |
getObjectiveBankSearchOrder()
Gets an objective bank search order.
|
canSearchObjectiveBanks, getObjectiveBankQuery, getObjectiveBanksByQuery
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
ObjectiveBankSearch getObjectiveBankSearch()
mandatory
- This method must be implemented. ObjectiveBankSearchOrder getObjectiveBankSearchOrder()
ObjectiveBankSearchOrder
is supplied to a
ObjectiveBankSearch
to specify the ordering of results.mandatory
- This method must be implemented. ObjectiveBankSearchResults getObjectiveBanksBySearch(ObjectiveBankQuery objectiveBankQuery, ObjectiveBankSearch objectiveBankSearch) throws OperationFailedException, PermissionDeniedException
objectiveBankQuery
- the objective bank queryobjectiveBankSearch
- the objective bank searchNullArgumentException
- objectiveBankQuery
or objectiveBankSearch
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- objectiveBankQuery
or objectiveBankSearch
is not of this
servicemandatory
- This method must be implemented. ObjectiveBankQuery getObjectiveBankQueryFromInspector(ObjectiveBankQueryInspector objectiveBankQueryInspector)
ObjectiveBankSearchResults.
objectiveBankQueryInspector
- an objective bank query inspectorNullArgumentException
-
objectiveBankQueryInspector
is null
UnsupportedException
-
objectiveBankQueryInspector
is not of this servicemandatory
- This method must be implemented.