OSID Specifications
profile package
Version 3.1.0
profile package
Version 3.1.0
| Interface | osid.profile.ProfileHierarchyDesignSession | ||
|---|---|---|---|
| Implements | osid.OsidSession | ||
| Used By | osid.profile.ProfileManager | ||
osid.profile.ProfileProxyManager | |||
| Description |
This session defines methods for managing a hierarchy of
| ||
| Method | getProfileHierarchyId | ||
| Description |
Gets the hierarchy | ||
| Return | osid.id.Id | the hierarchy Id associated with this session | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getProfileHierarchy | ||
| 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 | canModifyProfileHierarchy | ||
| 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 | addRootProfile | ||
| Description |
Adds a root profile. | ||
| Parameters | osid.id.Id | profileId | the Id of a profile |
| Errors | ALREADY_EXISTS | profileId is already in hierarchy | |
| NOT_FOUND | profileId not found | ||
| NULL_ARGUMENT | profileId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | removeRootProfile | ||
| Description |
Removes a root profile. | ||
| Parameters | osid.id.Id | profileId | the Id of a profile |
| Errors | NOT_FOUND | profileId not a root | |
| NULL_ARGUMENT | profileId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | addChildProfile | ||
| Description |
Adds a child to a profile. | ||
| Parameters | osid.id.Id | profileId | the Id of a profile |
osid.id.Id | childId | the Id of the new child | |
| Errors | ALREADY_EXISTS | profileId is already a parent of childId | |
| NOT_FOUND | profileId or childId not found | ||
| NULL_ARGUMENT | profileId or childId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | removeChildProfile | ||
| Description |
Removes a child from a profile. | ||
| Parameters | osid.id.Id | profileId | the Id of a profile |
osid.id.Id | childId | the Id of the new child | |
| Errors | NOT_FOUND | profileId not a parent of childId | |
| NULL_ARGUMENT | profileId or childId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | removeChildProfiles | ||
| Description |
Removes all children from a profile. | ||
| Parameters | osid.id.Id | profileId | the Id of a profile |
| Errors | NOT_FOUND | profileId not in hierarchy | |
| NULL_ARGUMENT | profileId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |