public interface SubjectSearchSession extends SubjectQuerySession
This session provides methods for searching Subject
objects. The search query is constructed using the SubjectQuery.
The subject record Type
also specifies the record
for the subject query.
getSubjectsByQuery()
is the basic search method and
returns a list of Subjects.
A more advanced search may be
performed with getSubjectsBySearch().
It accepts a
SubjectSearch
in addition to the query for the purpose of
specifying additional options affecting the entire search, such as
ordering. getSubjectsBySearch()
returns a
SubjectSearchResults
that can be used to access the resulting
SubjectList
or be used to perform a search within the
result set through SubjectSearch.
This session defines views that offer differing behaviors for searching.
Subjects may have a query record indicated by their respective record
types. The query record is accessed via the SubjectQuery.
Modifier and Type | Method and Description |
---|---|
SubjectQuery |
getSubjectQueryFromInspector(SubjectQueryInspector subjectQueryInspector)
Gets a subject query from an inspector.
|
SubjectSearchResults |
getSubjectsBySearch(SubjectQuery subjectQuery,
SubjectSearch subjectSearch)
Gets the search results matching the given search query using the
given search.
|
SubjectSearch |
getSubjectSearch()
Gets a subject search.
|
SubjectSearchOrder |
getSubjectSearchOrder()
Gets a subject search order.
|
canSearchSubjects, getOntology, getOntologyId, getSubjectQuery, getSubjectsByQuery, useFederatedOntologyView, useIsolatedOntologyView
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
SubjectSearch getSubjectSearch()
mandatory
- This method must be implemented. SubjectSearchOrder getSubjectSearchOrder()
SubjectSearchOrder
is
supplied to a SubjectSearch
to specify the ordering of
results.mandatory
- This method must be implemented. SubjectSearchResults getSubjectsBySearch(SubjectQuery subjectQuery, SubjectSearch subjectSearch) throws OperationFailedException, PermissionDeniedException
subjectQuery
- the subject querysubjectSearch
- the subject searchNullArgumentException
- subjectQuery
or
subjectSearch
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- subjectSearch
or
subjectQuery
is not of this servicemandatory
- This method must be implemented. SubjectQuery getSubjectQueryFromInspector(SubjectQueryInspector subjectQueryInspector)
SubjecttSearchResults.
subjectQueryInspector
- a subject query inspectorNullArgumentException
- subjectQueryInspector
is null
UnsupportedException
- subjectQueryInspector
is not of this servicemandatory
- This method must be implemented.