OSID Logo
OSID Specifications
hierarchy package
Version 3.0.0
Release Candidate Preview
Interfaceosid.hierarchy.HierarchySequencingSession
Implementsosid.OsidSession
Description

This session provides methods to sequence the nodes in a hierarchy.

MethodgetHierarchyId
Description

Gets the hierarchy Id associated with this session.

Returnosid.id.Idthe hierarchy Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetHierarchy
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.
MethodcanSequenceHierarchy
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.
MethodmoveNodeAhead
Description

Moves a node ahead of a refrence node under the given parent.

Parametersosid.id.IdparentIdthe Id of the parent node
osid.id.IdreferenceIdthe Id of the node
osid.id.Ididthe Id of the node to move ahead of referenceId
ErrorsNOT_FOUND parentId, referenceId, or id not found, or referenceId or id is not a child of parentId
NULL_ARGUMENT parentId, referenceId, or id is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodmoveNodeBehind
Description

Moves a node behind a refrence node under the given parent.

Parametersosid.id.IdparentIdthe Id of the parent node
osid.id.IdreferenceIdthe Id of the node
osid.id.Ididthe Id of the node to move behind referenceId
ErrorsNOT_FOUND parentId, referenceId, or id not found, or referenceId or id is not a child of parentId
NULL_ARGUMENT parentId, referenceId, or id is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodsequenceNodes
Description

Sequences a set of nodes under a parent.

Parametersosid.id.IdparentIdthe Id of the parent node
osid.id.Id[]idsthe Id of the nodes
ErrorsNOT_FOUND parentId or an id not found, or an id is not a child of parentId
NULL_ARGUMENT parentId or ids is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.