Interface HierarchyDesignSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface HierarchyDesignSession
extends OsidSession

This session provides methods to manage a hierarchy. Each node is expressed as an OSID Id that represents an external object. The hierarchy only expresses relationships among these Ids. However, changing the hierarchy may have implications, such as inherited data, in the associated OSID.

Method Summary

Modifier and Type	Method	Description
void	addChild(Id id, Id childId)	Adds a child to a Id .
void	addRoot(Id id)	Adds a root node.
boolean	canModifyHierarchy()	Tests if this user can change the hierarchy.
Hierarchy	getHierarchy()	Gets the hierarchy associated with this session.
Id	getHierarchyId()	Gets the hierarchy Id associated with this session.
void	removeChild(Id id, Id childId)	Removes a child from an Id .
void	removeChildren(Id id)	Removes all children from an Id .
void	removeRoot(Id id)	Removes a root node.

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

getHierarchyId

Id getHierarchyId()

Gets the hierarchy Id associated with this session.

Returns:

the hierarchy Id associated with this session

Compliance:

mandatory - This method must be implemented.

getHierarchy

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

canModifyHierarchy

boolean canModifyHierarchy()

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.

addRoot

void addRoot(Id id)
      throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds a root node.

Parameters:

id - the Id of the node

Throws:

AlreadyExistsException - id is already in hierarchy

NotFoundException - id not found

NullArgumentException - id is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

addChild

void addChild(Id id,
 Id childId)
       throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds a child to a Id .

Parameters:

id - the Id of the node

childId - the Id of the new child

Throws:

AlreadyExistsException - childId is already a child of id

NotFoundException - id or childId not found

NullArgumentException - id or childId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

removeRoot

void removeRoot(Id id)
         throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes a root node.

Parameters:

id - the Id of the node

Throws:

NotFoundException - id was not found or not in hierarchy

NullArgumentException - id is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

removeChild

void removeChild(Id id,
 Id childId)
          throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes a child from an Id .

Parameters:

id - the Id of the node

childId - the Id of the child to remove

Throws:

NotFoundException - id or childId was not found or childId is not a child of id

NullArgumentException - id or childId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

removeChildren

void removeChildren(Id id)
             throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes all children from an Id .

Parameters:

id - the Id of the node

Throws:

NotFoundException - a node identified by the given Id was not found

NullArgumentException - id is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.