org.osid.ontology

Interface RelevancyQuerySession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidSession

All Known Subinterfaces:

RelevancySearchSession

public interface RelevancyQuerySession
extends OsidSession

This session provides methods for searching Relevancy objects. The search query is constructed using the RelevancyQuery. The relevancy record Type also specifies the record for the relevancy query.

This session defines views that offer differing behaviors for searching.

• federated ontology view: searches include relevancies in ontologies of which this ontology is a ancestor in the ontology hierarchy
• isolated ontology view: searches are restricted

Relevancies may have a query record indicated by their respective record types. The query record is accessed via the RelevancyQuery.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canSearchRelevancies() Tests if this user can perform Relevancy searches.
Ontology	getOntology() Gets the Ontology associated with this session.
Id	getOntologyId() Gets the Ontology Id associated with this session.
RelevancyList	getRelevanciesByQuery(RelevancyQuery relevancyQuery) Gets a list of relevancies matching the given relevancy query.
RelevancyQuery	getRelevancyQuery() Gets a relevancy query.
void	useFederatedOntologyView() Federates the view for methods in this session.
void	useIsolatedOntologyView() Isolates the view for methods in this session.

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

getOntologyId

Id getOntologyId()

Gets the Ontology Id associated with this session.

Returns:

the Ontology Id associated with this session

Compliance:

mandatory - This method must be implemented.

getOntology

Ontology getOntology()
                     throws OperationFailedException,
                            PermissionDeniedException

Gets the Ontology associated with this session.

Returns:

the Ontology associated with this session

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canSearchRelevancies

boolean canSearchRelevancies()

Tests if this user can perform Relevancy 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.

useFederatedOntologyView

void useFederatedOntologyView()

Federates the view for methods in this session. A federated view will include relevancies in ontologies which are children of this ontology in the ontology hierarchy.

Compliance:

mandatory - This method is must be implemented.

useIsolatedOntologyView

void useIsolatedOntologyView()

Isolates the view for methods in this session. An isolated view restricts searches to this ontology only.

Compliance:

mandatory - This method is must be implemented.

getRelevancyQuery

RelevancyQuery getRelevancyQuery()

Gets a relevancy query.

Returns:

the relevancy query

Compliance:

mandatory - This method must be implemented.

getRelevanciesByQuery

RelevancyList getRelevanciesByQuery(RelevancyQuery relevancyQuery)
                                    throws OperationFailedException,
                                           PermissionDeniedException

Gets a list of relevancies matching the given relevancy query.

Parameters:

relevancyQuery - the relevancy query

Returns:

the returned RelevancyList

Throws:

NullArgumentException - relevancyQuery is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - relevancyQuery is not of this service

Compliance:

mandatory - This method must be implemented.