OSID Logo
OSID Specifications
topology package
Version 3.0.0
Release Candidate Preview
Interfaceosid.topology.GraphHierarchyDesignSession
Implementsosid.OsidSession
Description

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

MethodgetGraphHierarchyId
Description

Gets the hierarchy Id associated with this session.

Returnosid.id.Idthe hierarchy Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetGraphHierarchy
Description

Gets the hierarchy associated with this session.

Returnosid.hierarchy.Hierarchythe hierarchy associated with this session
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanModifyGraphHierarchy
Description

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.

Returnboolean false if changing this hierarchy is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodaddRootGraph
Description

Adds a root graph.

Parametersosid.id.IdgraphIdthe Id of a graph
ErrorsALREADY_EXISTS graphId is already in hierarchy
NOT_FOUND graphId not found
NULL_ARGUMENT graphId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodremoveRootGraph
Description

Removes a root graph.

Parametersosid.id.IdgraphIdthe Id of a graph
ErrorsNOT_FOUND graphId not a root
NULL_ARGUMENT graphId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodaddChildGraph
Description

Adds a child to a graph.

Parametersosid.id.IdgraphIdthe Id of a graph
osid.id.IdchildIdthe Id of the new child
ErrorsALREADY_EXISTS graphId is already a parent of childId
NOT_FOUND graphId or childId not found
NULL_ARGUMENT graphId or childId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodremoveChildGraph
Description

Removes a child from a graph.

Parametersosid.id.IdgraphIdthe Id of a graph
osid.id.IdchildIdthe Id of the new child
ErrorsNOT_FOUND graphId not a parent of childId
NULL_ARGUMENT graphId or childId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodremoveChildGraphs
Description

Removes all children from a graph.

Parametersosid.id.IdgraphIdthe Id of a graph
ErrorsNOT_FOUND graphId not in hierarchy
NULL_ARGUMENT graphId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.