OSID Logo
OSID Specifications
personnel package
Version 3.0.0
Release Candidate Preview
Interfaceosid.personnel.OrganizationHierarchyDesignSession
Implementsosid.OsidSession
Description

This session defines methods for managing a hierarchy of Organization objects. Each node in the hierarchy is a unique Organization.

MethodgetOrganizationHierarchyId
Description

Gets the hierarchy Id associated with this session.

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

Adds a root organization.

Parametersosid.id.IdorganizationIdthe Id of an organization
ErrorsALREADY_EXISTS organizationId is already in hierarchy
NOT_FOUND organizationId not found
NULL_ARGUMENT organizationId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodremoveRootOrganization
Description

Removes a root organization.

Parametersosid.id.IdorganizationIdthe Id of an organization
ErrorsNOT_FOUND organizationId not found
NULL_ARGUMENT organizationId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodaddChildOrganization
Description

Adds a child to an organization.

Parametersosid.id.IdorganizationIdthe Id of an organization
osid.id.IdchildIdthe Id of the new child
ErrorsALREADY_EXISTS organizationId is already a parent of childId
NOT_FOUND organizationId or childId not found
NULL_ARGUMENT organizationId or childId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodremoveChildOrganization
Description

Removes a child from an organization.

Parametersosid.id.IdorganizationIdthe Id of a n organization
osid.id.IdchildIdthe Id of the new child
ErrorsNOT_FOUND organizationId not a parent of childId
NULL_ARGUMENT organizationId or childId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodremoveChildOrganizations
Description

Removes all children from an organization.

Parametersosid.id.IdorganizationIdthe Id of an organization
ErrorsNOT_FOUND organizationId not found
NULL_ARGUMENT organizationId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.