Interface RelevancyOntologySession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface RelevancyOntologySession
extends OsidSession

This session provides methods to retrieve Relevancy to Ontology mappings. A Relevancy may appear in multiple Ontologies . Each Ontology may have its own authorizations governing who is allowed to look at it.

This lookup session defines two views:

• comparative view: elements may be silently omitted or re-ordered
• plenary view: provides a complete result set or is an error condition

Method Summary

Modifier and Type	Method	Description
boolean	canLookupRelevancyOntologyMappings()	Tests if this user can perform lookups of relevancy/ontology mappings.
OntologyList	getOntologiesByRelevancy(Id relevancyId)	Gets the list of Ontologies mapped to a Relevancy .
IdList	getOntologyIdsByRelevancy(Id relevancyId)	Gets the list of Ontology Ids mapped to a Relevancy
RelevancyList	getRelevanciesByOntologies(IdList ontologyIds)	Gets the list of Relevancies corresponding to a list of Ontologies .
RelevancyList	getRelevanciesByOntology(Id ontologyId)	Gets the list of Relevancies associated with an Ontology .
IdList	getRelevancyIdsByOntologies(IdList ontologyIds)	Gets the list of Relevancy Ids corresponding to a list of Ontologies .
IdList	getRelevancyIdsByOntology(Id ontologyId)	Gets the list of Relevancy Ids associated with an Ontology .
void	useComparativeOntologyView()	The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error.
void	usePlenaryOntologyView()	A complete view of the Relevancy and Ontology returns is desired.

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

canLookupRelevancyOntologyMappings

boolean canLookupRelevancyOntologyMappings()

Tests if this user can perform lookups of relevancy/ontology mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known lookup 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 lookup operations to unauthorized users.

Returns:

false if looking up mappings is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

useComparativeOntologyView

void useComparativeOntologyView()

The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision.

Compliance:

mandatory - This method is must be implemented.

usePlenaryOntologyView

void usePlenaryOntologyView()

A complete view of the Relevancy and Ontology returns is desired. Methods will return what is requested or result in an error. This view is used when greater precision is desired at the expense of interoperability.

Compliance:

mandatory - This method is must be implemented.

getRelevancyIdsByOntology

IdList getRelevancyIdsByOntology(Id ontologyId)
                          throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of Relevancy Ids associated with an Ontology .

Parameters:

ontologyId - Id of the Ontology

Returns:

list of related ontology Ids

Throws:

NotFoundException - ontologyId is not found

NullArgumentException - ontologyId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getRelevanciesByOntology

RelevancyList getRelevanciesByOntology(Id ontologyId)
                                throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of Relevancies associated with an Ontology .

Parameters:

ontologyId - Id of the Ontology

Returns:

list of related relevancy Ids

Throws:

NotFoundException - ontologyId is not found

NullArgumentException - ontologyId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getRelevancyIdsByOntologies

IdList getRelevancyIdsByOntologies(IdList ontologyIds)
                            throws OperationFailedException,
PermissionDeniedException

Gets the list of Relevancy Ids corresponding to a list of Ontologies .

Parameters:

ontologyIds - list of ontology Ids

Returns:

list of relevancy Ids

Throws:

NullArgumentException - ontologyIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getRelevanciesByOntologies

RelevancyList getRelevanciesByOntologies(IdList ontologyIds)
                                  throws OperationFailedException,
PermissionDeniedException

Gets the list of Relevancies corresponding to a list of Ontologies .

Parameters:

ontologyIds - list of ontology Ids

Returns:

list of relevancies

Throws:

NullArgumentException - ontologyIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getOntologyIdsByRelevancy

IdList getOntologyIdsByRelevancy(Id relevancyId)
                          throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of Ontology Ids mapped to a Relevancy

Parameters:

relevancyId - Id of a Relevancy

Returns:

list of ontology Ids

Throws:

NotFoundException - relevancyId is not found

NullArgumentException - relevancyId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getOntologiesByRelevancy

OntologyList getOntologiesByRelevancy(Id relevancyId)
                               throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of Ontologies mapped to a Relevancy .

Parameters:

relevancyId - Id of a Relevancy

Returns:

list of ontologies

Throws:

NotFoundException - relevancyId is not found

NullArgumentException - relevancyId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.