public interface OntologySearchSession extends OntologyQuerySession
This session provides methods for searching among Ontology
objects. The search query is constructed using the
OntologyQuery.
getOntologiesByQuery()
is the basic search method and
returns a list of Ontology
objects.A more advanced search
may be performed with getOntologiesBySearch().
It accepts
an OntologySearch
in addition to the query for the purpose
of specifying additional options affecting the entire search, such as
ordering. getOntologiesBySearch()
returns an
OntologySearchResults
that can be used to access the resulting
OntologyList
or be used to perform a search within the
result set through OntologySearch.
Ontologies may have a query record indicated by their respective
record types. The query record is accessed via the OntologyQuery.
Modifier and Type | Method and Description |
---|---|
OntologySearchResults |
getOntologiesBySearch(OntologyQuery ontologyQuery,
OntologySearch ontologySearch)
Gets the search results matching the given search query using the
given search.
|
OntologyQuery |
getOntologyQueryFromInspector(OntologyQueryInspector ontologyQueryInspector)
Gets an ontology query from an inspector.
|
OntologySearch |
getOntologySearch()
Gets an ontology search.
|
OntologySearchOrder |
getOntologySearchOrder()
Gets an ontology search order.
|
canSearchOntologies, getOntologiesByQuery, getOntologyQuery
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
OntologySearch getOntologySearch()
mandatory
- This method must be implemented. OntologySearchOrder getOntologySearchOrder()
OntologySearchOrder
is supplied to an OntologySearch
to specify the
ordering of results.mandatory
- This method must be implemented. OntologySearchResults getOntologiesBySearch(OntologyQuery ontologyQuery, OntologySearch ontologySearch) throws OperationFailedException, PermissionDeniedException
ontologyQuery
- the ontology queryontologySearch
- the ontology searchNullArgumentException
- ontologyQuery
or
ontologySearch
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- ontologyQuery
or
ontologySearch
is not of this servicemandatory
- This method must be implemented. OntologyQuery getOntologyQueryFromInspector(OntologyQueryInspector ontologyQueryInspector)
OntologySearchResults.
ontologyQueryInspector
- an ontology query inspectorNullArgumentException
- ontologyQueryInspector
is null
UnsupportedException
- ontologyQueryInspector
is not of this servicemandatory
- This method must be implemented.