OSID - osid.personnel.RealmHierarchyDesignSession Service Interface Definition

Interface	osid.personnel.RealmHierarchyDesignSession
Implements	`osid.OsidSession`
Used By	`osid.personnel.PersonnelManager`
Used By	`osid.personnel.PersonnelProxyManager`
Description	This session manages a hierarchy of realms. Realms may be organized into a hierarchy for organizing or federating. A parent `Realm` includes all of the persons of its children such that a single root node contains all of the persons of the federation.
Method	getRealmHierarchyId
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	getRealmHierarchy
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	canModifyRealmHierarchy
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	addRootRealm
Description	Adds a root realm.
Parameters	`osid.id.Id`	`realmId`	the `Id` of a realm
Errors	ALREADY_EXISTS		`realmId` is already in hierarchy
	NOT_FOUND		`realmId` is not found
	NULL_ARGUMENT		`realmId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	removeRootRealm
Description	Removes a root realm.
Parameters	`osid.id.Id`	`realmId`	the `Id` of a realm
Errors	NOT_FOUND		`realmId` is not found
	NULL_ARGUMENT		`realmId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	addChildRealm
Description	Adds a child to a realm.
Parameters	`osid.id.Id`	`realmId`	the `Id` of a realm
Parameters	`osid.id.Id`	`childId`	the `Id` of the new child
Errors	ALREADY_EXISTS		`realmId` is already a parent of `childId`
	NOT_FOUND		`realmId` or `childId` not found
	NULL_ARGUMENT		`realmId` or `childId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	removeChildRealm
Description	Removes a child from a realm.
Parameters	`osid.id.Id`	`realmId`	the `Id` of a realm
Parameters	`osid.id.Id`	`childId`	the `Id` of the new child
Errors	NOT_FOUND		`realmId` not a parent of `childId`
	NULL_ARGUMENT		`realmId` or `childId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	removeChildRealms
Description	Removes all children from a realm.
Parameters	`osid.id.Id`	`realmId`	the `Id` of a realm
Errors	NOT_FOUND		`realmId` is not found
	NULL_ARGUMENT		`realmId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.