public interface InstructionSearchSession extends InstructionQuerySession
This session provides methods for searching among Instruction
objects. The search query is constructed using the
InstructionQuery.
getInstructionsByQuery()
is the basic search method and
returns a list of Instructions.
A more advanced search may
be performed with getInstructionsBySearch().
It accepts an
InstructionSearch
in addition to the query for the purpose
of specifying additional options affecting the entire search, such as
ordering. getInstructionsBySearch()
returns an
InstructionSearchResults
that can be used to access the resulting
InstructionList
or be used to perform a search within the
result set through InstructionSearch.
This session defines views that offer differing behaviors for searching.
Instructions may have a query record indicated by their respective
record types. The query record is accessed via the
InstructionQuery.
Modifier and Type | Method and Description |
---|---|
InstructionQuery |
getInstructionQueryFromInspector(InstructionQueryInspector instructionQueryInspector)
Gets an instruction query.
|
InstructionSearchResults |
getInstructionsBySearch(InstructionQuery instructionQuery,
InstructionSearch instructionSearch)
Gets the search results matching the given search query using the
given search.
|
InstructionSearch |
getInstructionSearch()
Gets an instruction search.
|
InstructionSearchOrder |
getInstructionSearchOrder()
Gets an instruction search order.
|
canSearchInstructions, getEngine, getEngineId, getInstructionQuery, getInstructionsByQuery, useFederatedEngineView, useIsolatedEngineView
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
InstructionSearch getInstructionSearch()
mandatory
- This method must be implemented. InstructionSearchOrder getInstructionSearchOrder()
InstructionSearchOrder
is supplied to an InstructionSearch
to specify
the ordering of results.mandatory
- This method must be implemented. InstructionSearchResults getInstructionsBySearch(InstructionQuery instructionQuery, InstructionSearch instructionSearch) throws OperationFailedException, PermissionDeniedException
instructionQuery
- the instruction queryinstructionSearch
- the instruction searchNullArgumentException
- instructionQuery
or instructionSearch
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- instructionQuery
or instructionSearch
is not of this servicemandatory
- This method must be implemented. InstructionQuery getInstructionQueryFromInspector(InstructionQueryInspector instructionQueryInspector)
InstructionSearchResults.
instructionQueryInspector
- an instruction query inspectorNullArgumentException
-
instructionQueryInspector
is null
UnsupportedException
- instructionQueryInspector
is not of this servicemandatory
- This method must be implemented.