OSID Logo
OSID Specifications
hold package
Version 3.0.0
Release Candidate Preview
Interfaceosid.hold.OublietteHierarchyDesignSession
Implementsosid.OsidSession
Description

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

MethodgetOublietteHierarchyId
Description

Gets the hierarchy Id associated with this session.

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

Adds a root oubliette.

Parametersosid.id.IdoublietteIdthe Id of an oubliette
ErrorsALREADY_EXISTS oublietteId is already in hierarchy
NOT_FOUND oublietteId not found
NULL_ARGUMENT oublietteId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodremoveRootOubliette
Description

Removes a root oubliette.

Parametersosid.id.IdoublietteIdthe Id of an oubliette
ErrorsNOT_FOUND oublietteId is not a root
NULL_ARGUMENT oublietteId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodaddChildOubliette
Description

Adds a child to an oubliette.

Parametersosid.id.IdoublietteIdthe Id of an oubliette
osid.id.IdchildIdthe Id of the new child
ErrorsALREADY_EXISTS oublietteId is already a parent of childId
NOT_FOUND oublietteId or childId not found
NULL_ARGUMENT oublietteId or childId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodremoveChildOubliette
Description

Removes a child from an oubliette.

Parametersosid.id.IdoublietteIdthe Id of an oubliette
osid.id.IdchildIdthe Id of the new child
ErrorsNOT_FOUND oublietteId is not parent of childId
NULL_ARGUMENT oublietteId or childId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodremoveChildOubliettes
Description

Removes all children from an oubliette.

Parametersosid.id.IdoublietteIdthe Id of an oubliette
ErrorsNOT_FOUND oublietteId is not found
NULL_ARGUMENT oublietteId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.