public interface AssessmentPartSearchSession extends AssessmentPartQuerySession
This session provides methods for searching among AssessmentPart
objects. The search query is constructed using the
AssessmentPartyQuery.
getAssessmentPartsByQuery()
is the basic search method
and returns a list of AssessmentParts.
A more advanced
search may be performed with getAssessmentPartsBySearch().
It accepts an AssessmentPartSearch
in addition to the query
for the purpose of specifying additional options affecting the entire
search, such as workflow. getAssessmentPartsBySearch()
returns an AssessmentPartSearchResults
that can be used to
access the resulting AssessmentPartList
or be used to
perform a search within the result set through
AssessmentPartSearch.
This session defines views that offer differing behaviors for searching.
AssessmentParts
may have a query record indicated by
their respective record types. Thequery record is accessed via the
AssessmentPartQuery.
Modifier and Type | Method and Description |
---|---|
AssessmentPartQuery |
getAssessmentPartQueryFromInspector(AssessmentPartQueryInspector assessmentPartQueryInspector)
Gets an assessment part query from an inspector.
|
AssessmentPartSearchResults |
getAssessmentPartsBySearch(AssessmentPartQuery assessmentPartQuery,
AssessmentPartSearch assessmentPartSearch)
Gets the search results matching the given search query using the
given search.
|
AssessmentPartSearch |
getAssessmentPartSearch()
Gets an assessment part search.
|
AssessmentPartSearchOrder |
getAssessmentPartSearchOrder()
Gets an assessment part search order.
|
canSearchAssessmentParts, getAssessmentPartQuery, getAssessmentPartsByQuery, getBank, getBankId, useFederatedBankView, useIsolatedBankView, useSequesteredAssessmentPartView, useUnsequesteredAssessmentPartView
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
AssessmentPartSearch getAssessmentPartSearch()
mandatory
- This method must be implemented. AssessmentPartSearchOrder getAssessmentPartSearchOrder()
AssessmentPartSearchOrder
is supplied to an
AssessmentPartSearch
to specify the ordering of results.mandatory
- This method must be implemented. AssessmentPartSearchResults getAssessmentPartsBySearch(AssessmentPartQuery assessmentPartQuery, AssessmentPartSearch assessmentPartSearch) throws OperationFailedException, PermissionDeniedException
assessmentPartQuery
- the assessment part queryassessmentPartSearch
- the assessment part searchNullArgumentException
- assessmentPartQuery
or assessmentPartSearch
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- assessmentPartQuery
or assessmentPartSearch
is not of this
servicemandatory
- This method must be implemented. AssessmentPartQuery getAssessmentPartQueryFromInspector(AssessmentPartQueryInspector assessmentPartQueryInspector)
AssessmentPartSearchResults.
assessmentPartQueryInspector
- an assessment part query
inspectorNullArgumentException
-
assessmentPartQueryInspector
is null
UnsupportedException
-
assessmentPartQueryInspector
is not of this servicemandatory
- This method must be implemented.