Interface OntologySearchSession

All Superinterfaces:

AutoCloseable, Closeable, OntologyQuerySession, OsidSession, OsidSession

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 .

Method Summary

Modifier and Type	Method	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.

Methods inherited from interface Closeable

close

Methods inherited from interface OntologyQuerySession

canSearchOntologies, getOntologiesByQuery, getOntologyQuery

Modifier and Type	Method	Description
boolean	canSearchOntologies()	Tests if this user can perform Ontology searches.
OntologyList	getOntologiesByQuery(OntologyQuery ontologyQuery)	Gets a list of Ontology objects matching the given ontology query.
OntologyQuery	getOntologyQuery()	Gets an ontology query.

Methods inherited from interface OsidSession

close

Modifier and Type	Method	Description
void	close()	Close this session.

Methods inherited from interface OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Modifier and Type	Method	Description
Agent	getAuthenticatedAgent()	Gets the agent authenticated to this session.
Id	getAuthenticatedAgentId()	Gets the Id of the agent authenticated to this session.
BigDecimal	getClockRate()	Gets the rate of the service clock.
Date	getDate()	Gets the service date which may be the current date or the effective date in which this session exists.
Agent	getEffectiveAgent()	Gets the effective agent in use by this session.
Id	getEffectiveAgentId()	Gets the Id of the effective agent in use by this session.
Type	getFormatType()	Gets the DisplayText format Type preference in effect for this session.
Locale	getLocale()	Gets the locale indicating the localization preferences in effect for this session.
boolean	isAuthenticated()	Tests if an agent is authenticated to this session.
Transaction	startTransaction()	Starts a new transaction for this sesson.
boolean	supportsTransactions()	Tests for the availability of transactions.

Method Details

getOntologySearch

OntologySearch getOntologySearch()

Gets an ontology search.

Returns:

an ontology search

Compliance:

mandatory - This method must be implemented.

getOntologySearchOrder

OntologySearchOrder getOntologySearchOrder()

Gets an ontology search order. The OntologySearchOrder is supplied to an OntologySearch to specify the ordering of results.

Returns:

the ontology search order

Compliance:

mandatory - This method must be implemented.

getOntologiesBySearch

OntologySearchResults getOntologiesBySearch(OntologyQuery ontologyQuery,
 OntologySearch ontologySearch)
                                     throws OperationFailedException,
PermissionDeniedException

Gets the search results matching the given search query using the given search.

Parameters:

ontologyQuery - the ontology query

ontologySearch - the ontology search

Returns:

the ontology search results

Throws:

NullArgumentException - ontologyQuery or ontologySearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - ontologyQuery or ontologySearch is not of this service

Compliance:

mandatory - This method must be implemented.

getOntologyQueryFromInspector

OntologyQuery getOntologyQueryFromInspector(OntologyQueryInspector ontologyQueryInspector)

Gets an ontology query from an inspector. The inspector is available from an OntologySearchResults .

Parameters:

ontologyQueryInspector - an ontology query inspector

Returns:

the ontology query

Throws:

NullArgumentException - ontologyQueryInspector is null

UnsupportedException - ontologyQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.