public interface AssessmentSearchSession extends AssessmentQuerySession
This session provides methods for searching among Assessment
objects. The search query is constructed using the
AssessmentQuery.
getAssessmentsByQuery()
is the basic search method and
returns a list of Assessments.
A more advanced search may
be performed with getAssessmentsBySearch().
It accepts an
AssessmentSearch
in addition to the query for the purpose
of specifying additional options affecting the entire search, such as
ordering. getAssessmentsBySearch()
returns an
AssessmentSearchResults
that can be used to access the resulting
AssessmentList
or be used to perform a search within the
result set through AssessmentSearch.
This session defines views that offer differing behaviors for searching.
Assessments may have a query record indicated by their respective
record types. The query record is accessed via the AssessmentQuery.
Modifier and Type | Method and Description |
---|---|
AssessmentQuery |
getAssessmentQueryFromInspector(AssessmentQueryInspector assessmentQueryInspector)
Gets an assessment query from an inspector.
|
AssessmentSearchResults |
getAssessmentsBySearch(AssessmentQuery assessmentQuery,
AssessmentSearch assessmentSearch)
Gets the search results matching the given search query using the
given search.
|
AssessmentSearch |
getAssessmentSearch()
Gets an assessment search.
|
AssessmentSearchOrder |
getAssessmentSearchOrder()
Gets an assessment search order.
|
canSearchAssessments, getAssessmentQuery, getAssessmentsByQuery, getBank, getBankId, useFederatedBankView, useIsolatedBankView
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
AssessmentSearch getAssessmentSearch()
mandatory
- This method must be implemented. AssessmentSearchOrder getAssessmentSearchOrder()
AssessmentSearchOrder
is supplied to an AssessmentSearch
to specify
the ordering of results.mandatory
- This method must be implemented. AssessmentSearchResults getAssessmentsBySearch(AssessmentQuery assessmentQuery, AssessmentSearch assessmentSearch) throws OperationFailedException, PermissionDeniedException
assessmentQuery
- the assessment queryassessmentSearch
- the assessment searchNullArgumentException
- assessmentQuery
or assessmentSearch
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- assessmentQuery
or assessmentSearch
is not of this servicemandatory
- This method must be implemented. AssessmentQuery getAssessmentQueryFromInspector(AssessmentQueryInspector assessmentQueryInspector)
AssessmentSearchResults.
assessmentQueryInspector
- an assessment query inspectorNullArgumentException
- assessmentQueryInspector
is null
UnsupportedException
- assessmentQueryInspector
is not of this servicemandatory
- This method must be implemented.