Interface SubjectOntologySession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface SubjectOntologySession
extends OsidSession

This session provides methods to retrieve Subject to Ontology mappings. A Subject 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	canLookupSubjectOntologyMappings()	Tests if this user can perform lookups of subject/ontology mappings.
OntologyList	getOntologiesBySubject(Id subjectId)	Gets the list of Ontologies mapped to a Subject .
IdList	getOntologyIdsBySubject(Id subjectId)	Gets the list of Ontology Ids mapped to a Subject .
IdList	getSubjectIdsByOntologies(IdList ontologyIds)	Gets the list of Subject Ids corresponding to a list of Ontologies .
IdList	getSubjectIdsByOntology(Id ontologyId)	Gets the list of Subject Ids associated with an Ontology .
SubjectList	getSubjectsByOntologies(IdList ontologyIds)	Gets the list of Subjects corresponding to a list of Ontologies .
SubjectList	getSubjectsByOntology(Id ontologyId)	Gets the list of Subjects 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 Subject 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

canLookupSubjectOntologyMappings

boolean canLookupSubjectOntologyMappings()

Tests if this user can perform lookups of subject/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 Subject 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.

getSubjectIdsByOntology

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

Gets the list of Subject Ids associated with an Ontology .

Parameters:

ontologyId - Id of the Ontology

Returns:

list of related subject 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.

getSubjectsByOntology

SubjectList getSubjectsByOntology(Id ontologyId)
                           throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of Subjects associated with an Ontology .

Parameters:

ontologyId - Id of the Ontology

Returns:

list of related subject 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.

getSubjectIdsByOntologies

IdList getSubjectIdsByOntologies(IdList ontologyIds)
                          throws OperationFailedException,
PermissionDeniedException

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

Parameters:

ontologyIds - list of ontology Ids

Returns:

list of subject Ids

Throws:

NullArgumentException - ontologyIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getSubjectsByOntologies

SubjectList getSubjectsByOntologies(IdList ontologyIds)
                             throws OperationFailedException,
PermissionDeniedException

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

Parameters:

ontologyIds - list of ontology Ids

Returns:

list of subjects

Throws:

NullArgumentException - ontologyIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getOntologyIdsBySubject

IdList getOntologyIdsBySubject(Id subjectId)
                        throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of Ontology Ids mapped to a Subject .

Parameters:

subjectId - Id of a Subject

Returns:

list of ontology Ids

Throws:

NotFoundException - subjectId is not found

NullArgumentException - subjectId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getOntologiesBySubject

OntologyList getOntologiesBySubject(Id subjectId)
                             throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of Ontologies mapped to a Subject .

Parameters:

subjectId - Id of a Subject

Returns:

list of ontologies

Throws:

NotFoundException - subjectId is not found

NullArgumentException - subjectId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.