org.osid.ontology

Interface OntologyQuerySession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, 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

Methods

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

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

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

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.