Interface | osid.dictionary.DictionaryHierarchyDesignSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session manages a hierarchy of dictionaries. | ||
Method | getDictionaryHierarchyId | ||
Description |
Gets the hierarchy | ||
Return | osid.id.Id | the hierarchy Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getDictionaryHierarchy | ||
Description |
Gets the hierarchy associated with this session. | ||
Return | osid.hierarchy.Hierarchy | the hierarchy associated with this session | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canModifyDictionaryHierarchy | ||
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 | ||
Return | boolean | false if changing this hierarchy is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | addRootDictionary | ||
Description |
Adds a root dictionary. | ||
Parameters | osid.id.Id | dictionaryId | the Id of a dicrtionary |
Errors | ALREADY_EXISTS | dictionaryId is already in hierarchy | |
NOT_FOUND | dictionaryId not found | ||
NULL_ARGUMENT | dictionaryId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | removeRootDictionary | ||
Description |
Removes a root dictionary. | ||
Parameters | osid.id.Id | dictionaryId | the Id of a dicrtionary |
Errors | NOT_FOUND | dictionaryId is not a root | |
NULL_ARGUMENT | dictionaryId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | addChildDictionary | ||
Description |
Adds a child to a dictionary. | ||
Parameters | osid.id.Id | dictionaryId | the Id of a dictionary |
osid.id.Id | childId | the Id of the new child | |
Errors | ALREADY_EXISTS | dictionaryId is already a parent of childId | |
NOT_FOUND | dictionaryId or childId not found | ||
NULL_ARGUMENT | dictionaryId or childId is null
| ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | removeChildDictionary | ||
Description |
Removes a child from a dictionary. | ||
Parameters | osid.id.Id | dictionaryId | the Id of a dictionary |
osid.id.Id | childId | the Id of the new child | |
Errors | NOT_FOUND | dictionaryId not a parent of childId | |
NULL_ARGUMENT | dictionaryId or childId is null
| ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | removeChildDictionaries | ||
Description |
Removes all children from a dictionary. | ||
Parameters | osid.id.Id | dictionaryId | the Id of a dictionary |
Errors | NOT_FOUND | dictionaryId is not in hierarchy | |
NULL_ARGUMENT | dictionaryId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |