Interface | osid.authentication.AgencyHierarchyDesignSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session defines methods for managing a hierarchy of
| ||
Method | getAgencyHierarchyId | ||
Description |
Gets the hierarchy | ||
Return | osid.id.Id | the hierarchy Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getAgencyHierarchy | ||
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 | canModifyAgencyHierarchy | ||
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 | addRootAgency | ||
Description |
Adds a root agency. | ||
Parameters | osid.id.Id | agencyId | the Id of an agency |
Errors | ALREADY_EXISTS | agencyId is already in hierarchy | |
NOT_FOUND | agency not found | ||
NULL_ARGUMENT | agencyId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | removeRootAgency | ||
Description |
Removes a root agency from this hierarchy. | ||
Parameters | osid.id.Id | agencyId | the Id of an agency |
Errors | NOT_FOUND | agencyId not a parent of childId | |
NULL_ARGUMENT | agencyId or childId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | addChildAgency | ||
Description |
Adds a child to an agency. | ||
Parameters | osid.id.Id | agencyId | the Id of an agency |
osid.id.Id | childId | the Id of the new child | |
Errors | ALREADY_EXISTS | agencyId already a parent of childId | |
NOT_FOUND | agencyId or childId not found | ||
NULL_ARGUMENT | agencyId or childId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | removeChildAgency | ||
Description |
Removes a child from an agency. | ||
Parameters | osid.id.Id | agencyId | the Id of an agency |
osid.id.Id | childId | the Id of the new child | |
Errors | NOT_FOUND | agencyId is not a parent of childId | |
NULL_ARGUMENT | agencyId or childId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | removeChildAgencies | ||
Description |
Removes all children from an agency. | ||
Parameters | osid.id.Id | agencyId | the Id of an agency |
Errors | NOT_FOUND | agencyId is not in hierarchy | |
NULL_ARGUMENT | agencyId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |