OSID - osid.personnel.OrganizationHierarchyDesignSession Service Interface Definition

Interface	osid.personnel.OrganizationHierarchyDesignSession
Implements	`osid.OsidSession`
Used By	`osid.personnel.PersonnelManager`
Used By	`osid.personnel.PersonnelProxyManager`
Description	This session defines methods for managing a hierarchy of `Organization` objects. Each node in the hierarchy is a unique `Organization`.
Method	getOrganizationHierarchyId
Description	Gets the hierarchy `Id` associated with this session.
Return	`osid.id.Id`		the hierarchy `Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getOrganizationHierarchy
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
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canModifyOrganizationHierarchy
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.
Return	`boolean`		`false` if changing this hierarchy is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	addRootOrganization
Description	Adds a root organization.
Parameters	`osid.id.Id`	`organizationId`	the `Id` of an organization
Errors	ALREADY_EXISTS		`organizationId` is already in hierarchy
	NOT_FOUND		`organizationId` not found
	NULL_ARGUMENT		`organizationId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	removeRootOrganization
Description	Removes a root organization.
Parameters	`osid.id.Id`	`organizationId`	the `Id` of an organization
Errors	NOT_FOUND		`organizationId` not found
	NULL_ARGUMENT		`organizationId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	addChildOrganization
Description	Adds a child to an organization.
Parameters	`osid.id.Id`	`organizationId`	the `Id` of an organization
Parameters	`osid.id.Id`	`childId`	the `Id` of the new child
Errors	ALREADY_EXISTS		`organizationId` is already a parent of `childId`
	NOT_FOUND		`organizationId` or `childId` not found
	NULL_ARGUMENT		`organizationId` or `childId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	removeChildOrganization
Description	Removes a child from an organization.
Parameters	`osid.id.Id`	`organizationId`	the `Id` of a n organization
Parameters	`osid.id.Id`	`childId`	the `Id` of the new child
Errors	NOT_FOUND		`organizationId` not a parent of `childId`
	NULL_ARGUMENT		`organizationId` or `childId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	removeChildOrganizations
Description	Removes all children from an organization.
Parameters	`osid.id.Id`	`organizationId`	the `Id` of an organization
Errors	NOT_FOUND		`organizationId` not found
	NULL_ARGUMENT		`organizationId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.