Interface TermHierarchyDesignSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface TermHierarchyDesignSession
extends OsidSession

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

Method Summary

Modifier and Type	Method	Description
void	addChildTerm(Id termId, Id childId)	Adds a child to a term.
void	addRootTerm(Id termId)	Adds a root term.
boolean	canModifyTermHierarchy()	Tests if this user can change the hierarchy.
Hierarchy	getTermHierarchy()	Gets the hierarchy associated with this session.
Id	getTermHierarchyId()	Gets the hierarchy Id associated with this session.
void	removeChildTerm(Id termId, Id childId)	Removes a child from a term.
void	removeChildTerms(Id termId)	Removes all children from a term.
void	removeRootTerm(Id termId)	Removes a root term.

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

getTermHierarchyId

Id getTermHierarchyId()

Gets the hierarchy Id associated with this session.

Returns:

the hierarchy Id associated with this session

Compliance:

mandatory - This method must be implemented.

getTermHierarchy

Hierarchy getTermHierarchy()
                    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.

canModifyTermHierarchy

boolean canModifyTermHierarchy()

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.

addRootTerm

void addRootTerm(Id termId)
          throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds a root term.

Parameters:

termId - the Id of a term

Throws:

AlreadyExistsException - termId is already in hierarchy

NotFoundException - termId not found

NullArgumentException - termId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

removeRootTerm

void removeRootTerm(Id termId)
             throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes a root term.

Parameters:

termId - the Id of a term

Throws:

NotFoundException - termId not a root node

NullArgumentException - termId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

addChildTerm

void addChildTerm(Id termId,
 Id childId)
           throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds a child to a term.

Parameters:

termId - the Id of a term

childId - the Id of the new child

Throws:

AlreadyExistsException - termId is already a parent of childId

NotFoundException - termId or childId not found

NullArgumentException - termId or childId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

removeChildTerm

void removeChildTerm(Id termId,
 Id childId)
              throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes a child from a term.

Parameters:

termId - the Id of a term

childId - the Id of the new child

Throws:

NotFoundException - termId not a parent of childId

NullArgumentException - termId or childId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

removeChildTerms

void removeChildTerms(Id termId)
               throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes all children from a term.

Parameters:

termId - the Id of a term

Throws:

NotFoundException - termId is not in hierarchy

NullArgumentException - termId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.