Interface OntologyHierarchyDesignSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface OntologyHierarchyDesignSession
extends OsidSession

This session defines methods for managing a hierarchy of Ontology objects. Each node in the hierarchy is a unique Ontology .

Method Summary

Modifier and Type	Method	Description
void	addChildOntology(Id ontologyId, Id childId)	Adds a child to an ontology.
void	addRootOntology(Id ontologyId)	Adds a root ontology.
boolean	canModifyOntologyHierarchy()	Tests if this user can change the hierarchy.
Hierarchy	getOntologyHierarchy()	Gets the hierarchy associated with this session.
Id	getOntologyHierarchyId()	Gets the hierarchy Id associated with this session.
void	removeChildOntologies(Id ontologyId)	Removes all children from an ontology.
void	removeChildOntology(Id ontologyId, Id childId)	Removes a child from an ontology.
void	removeRootOntology(Id ontologyId)	Removes a root ontology.

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

getOntologyHierarchyId

Id getOntologyHierarchyId()

Gets the hierarchy Id associated with this session.

Returns:

the hierarchy Id associated with this session

Compliance:

mandatory - This method must be implemented.

getOntologyHierarchy

Hierarchy getOntologyHierarchy()
                        throws OperationFailedException,
PermissionDeniedException

Gets the hierarchy associated with this session.

Returns:

the hierarchy associated with this session

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canModifyOntologyHierarchy

boolean canModifyOntologyHierarchy()

Tests if this user can change the hierarchy. A return of true does not guarantee successful authorization. A return of false indicates that it is known performing any update will result in a PERMISSION_DENIED . This is intended as a hint to an application that may opt not to offer these operations to an unauthorized user.

Returns:

false if changing this hierarchy is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

addRootOntology

void addRootOntology(Id ontologyId)
              throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds a root ontology.

Parameters:

ontologyId - the Id of an ontology

Throws:

AlreadyExistsException - ontologyId is already in hierarchy

NotFoundException - ontologyId not found

NullArgumentException - ontologyId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

removeRootOntology

void removeRootOntology(Id ontologyId)
                 throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes a root ontology.

Parameters:

ontologyId - the Id of an ontology

Throws:

NotFoundException - ontologyId is not a root

NullArgumentException - ontologyId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

addChildOntology

void addChildOntology(Id ontologyId,
 Id childId)
               throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds a child to an ontology.

Parameters:

ontologyId - the Id of an ontology

childId - the Id of the new child

Throws:

AlreadyExistsException - ontologyId is already a parent of childId

NotFoundException - ontologyId or childId not found

NullArgumentException - ontologyId or childId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

removeChildOntology

void removeChildOntology(Id ontologyId,
 Id childId)
                  throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes a child from an ontology.

Parameters:

ontologyId - the Id of an ontology

childId - the Id of the new child

Throws:

NotFoundException - ontologyId not a parent of childId

NullArgumentException - ontologyId or childId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

removeChildOntologies

void removeChildOntologies(Id ontologyId)
                    throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes all children from an ontology.

Parameters:

ontologyId - the Id of an ontology

Throws:

NotFoundException - ontologyId not in hierarchy

NullArgumentException - ontologyId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.