Interface OntologyQuerySession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

All Known Subinterfaces:

OntologySearchSession

public interface OntologyQuerySession
extends OsidSession

This session provides methods for searching among Ontology objects. The search query is constructed using the OntologyQuery .

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
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 Closeable

close

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

canSearchOntologies

boolean canSearchOntologies()

Tests if this user can perform Ontology searches. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a PERMISSION_DENIED . This is intended as a hint to an application that may opt not to offer search operations to unauthorized users.

Returns:

false if search methods are not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

getOntologyQuery

OntologyQuery getOntologyQuery()

Gets an ontology query.

Returns:

an ontology query

Compliance:

mandatory - This method must be implemented.

getOntologiesByQuery

OntologyList getOntologiesByQuery(OntologyQuery ontologyQuery)
                           throws OperationFailedException,
PermissionDeniedException

Gets a list of Ontology objects matching the given ontology query.

Parameters:

ontologyQuery - the ontology query

Returns:

the returned OntologyList

Throws:

NullArgumentException - ontologyQuery is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - ontologyQuery is not of this service

Compliance:

mandatory - This method must be implemented.