Interface GraphHierarchyDesignSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface GraphHierarchyDesignSession
extends OsidSession

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

Method Summary

Modifier and Type	Method	Description
void	addChildGraph(Id graphId, Id childId)	Adds a child to a graph.
void	addRootGraph(Id graphId)	Adds a root graph.
boolean	canModifyGraphHierarchy()	Tests if this user can change the hierarchy.
Hierarchy	getGraphHierarchy()	Gets the hierarchy associated with this session.
Id	getGraphHierarchyId()	Gets the hierarchy Id associated with this session.
void	removeChildGraph(Id graphId, Id childId)	Removes a child from a graph.
void	removeChildGraphs(Id graphId)	Removes all children from a graph.
void	removeRootGraph(Id graphId)	Removes a root graph.

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

getGraphHierarchyId

Id getGraphHierarchyId()

Gets the hierarchy Id associated with this session.

Returns:

the hierarchy Id associated with this session

Compliance:

mandatory - This method must be implemented.

getGraphHierarchy

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

canModifyGraphHierarchy

boolean canModifyGraphHierarchy()

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.

addRootGraph

void addRootGraph(Id graphId)
           throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds a root graph.

Parameters:

graphId - the Id of a graph

Throws:

AlreadyExistsException - graphId is already in hierarchy

NotFoundException - graphId not found

NullArgumentException - graphId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

removeRootGraph

void removeRootGraph(Id graphId)
              throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes a root graph.

Parameters:

graphId - the Id of a graph

Throws:

NotFoundException - graphId not a root

NullArgumentException - graphId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

addChildGraph

void addChildGraph(Id graphId,
 Id childId)
            throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds a child to a graph.

Parameters:

graphId - the Id of a graph

childId - the Id of the new child

Throws:

AlreadyExistsException - graphId is already a parent of childId

NotFoundException - graphId or childId not found

NullArgumentException - graphId or childId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

removeChildGraph

void removeChildGraph(Id graphId,
 Id childId)
               throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes a child from a graph.

Parameters:

graphId - the Id of a graph

childId - the Id of the new child

Throws:

NotFoundException - graphId not a parent of childId

NullArgumentException - graphId or childId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

removeChildGraphs

void removeChildGraphs(Id graphId)
                throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes all children from a graph.

Parameters:

graphId - the Id of a graph

Throws:

NotFoundException - graphId not in hierarchy

NullArgumentException - graphId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.