Interface | osid.relationship.FamilyHierarchyDesignSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session manages a hierarchy of families may be
organized into a hierarchy for organizing or federating. A
parent | ||
Method | getFamilyHierarchyId | ||
Description |
Gets the hierarchy | ||
Return | osid.id.Id | the hierarchy Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getFamilyHierarchy | ||
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 | canModifyFamilyHierarchy | ||
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 | addRootFamily | ||
Description |
Adds a root family. | ||
Parameters | osid.id.Id | familyId | the Id of a family |
Errors | ALREADY_EXISTS | familyId is already in hierarchy | |
NOT_FOUND | familyId not found | ||
NULL_ARGUMENT | familyId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | removeRootFamily | ||
Description |
Removes a root family. | ||
Parameters | osid.id.Id | familyId | the Id of a family |
Errors | NOT_FOUND | familyId not a root | |
NULL_ARGUMENT | familyId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | addChildFamily | ||
Description |
Adds a child to a family. | ||
Parameters | osid.id.Id | familyId | the Id of a family |
osid.id.Id | childId | the Id of the new child | |
Errors | ALREADY_EXISTS | familyId is already a parent of childId | |
NOT_FOUND | familyId or childId not found | ||
NULL_ARGUMENT | familyId or childId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | removeChildFamily | ||
Description |
Removes a child from a family. | ||
Parameters | osid.id.Id | familyId | the Id of a family |
osid.id.Id | childId | the Id of the new child | |
Errors | NOT_FOUND | familyId not a parent of childId | |
NULL_ARGUMENT | familyId or childId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | removeChildFamilies | ||
Description |
Removes all children from a family. | ||
Parameters | osid.id.Id | familyId | the Id of a family |
Errors | NOT_FOUND | familyId not in hierarchy | |
NULL_ARGUMENT | familyId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |