OSID Logo
OSID Specifications
dictionary package
Version 3.0.0
Release Candidate Preview
Interfaceosid.dictionary.DictionaryHierarchyDesignSession
Implementsosid.OsidSession
Description

This session manages a hierarchy of dictionaries. Dictionary objects may be organized into a hierarchy for organizing or federating. A parent Dictionary includes all of the entries of its children such that a single root node contains all of the entries of the federation.

MethodgetDictionaryHierarchyId
Description

Gets the hierarchy Id associated with this session.

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

Adds a root dictionary.

Parametersosid.id.IddictionaryIdthe Id of a dicrtionary
ErrorsALREADY_EXISTS dictionaryId is already in hierarchy
NOT_FOUND dictionaryId not found
NULL_ARGUMENT dictionaryId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodremoveRootDictionary
Description

Removes a root dictionary.

Parametersosid.id.IddictionaryIdthe Id of a dicrtionary
ErrorsNOT_FOUND dictionaryId is not a root
NULL_ARGUMENT dictionaryId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodaddChildDictionary
Description

Adds a child to a dictionary.

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

Removes a child from a dictionary.

Parametersosid.id.IddictionaryIdthe Id of a dictionary
osid.id.IdchildIdthe Id of the new child
ErrorsNOT_FOUND dictionaryId not a parent of childId
NULL_ARGUMENT dictionaryId or childId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodremoveChildDictionaries
Description

Removes all children from a dictionary.

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