OSID - osid.personnel.RealmHierarchySession Service Interface Definition

Interface	osid.personnel.RealmHierarchySession
Implements	`osid.OsidSession`
Description	This session defines methods for traversing a hierarchy of `Realm` objects. Each node in the hierarchy is a unique `Realm.` The hierarchy may be traversed recursively to establish the tree structure through `getParentRealms()` and `getChildRealms().` To relate these `Ids` to another OSID, `getRealmNodes()` can be used for retrievals that can be used for bulk lookups in other OSIDs. Any `Realm` available in the Personnel OSID is known to this hierarchy but does not appear in the hierarchy traversal until added as a root node or a child of another node. A user may not be authorized to traverse the entire hierarchy. Parts of the hierarchy may be made invisible through omission from the returns of `getParentRealms()` or `getChildRealms()` in lieu of a `PERMISSION_DENIED` error that may disrupt the traversal through authorized pathways. This session defines views that offer differing behaviors when retrieving multiple objects. comparative view: realm elements may be silently omitted or re-ordered plenary view: provides a complete set or is an error condition
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	canAccessRealmHierarchy
Description	Tests if this user can perform hierarchy queries. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a `PERMISSION_DENIED.` This is intended as a hint to an application that may opt not to offer lookup operations.
Return	`boolean`		`false` if hierarchy traversal methods are not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	useComparativeRealmView
Description	The returns from the realm methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision.
Compliance	`mandatory`		This method is must be implemented.
Method	usePlenaryRealmView
Description	A complete view of the `Realm` returns is desired. Methods will return what is requested or result in an error. This view is used when greater precision is desired at the expense of interoperability.
Compliance	`mandatory`		This method is must be implemented.
Method	getRootRealmIds
Description	Gets the root realm `Ids` in this hierarchy.
Return	`osid.id.IdList`		the root realm `Ids`
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getRootRealms
Description	Gets the root realms in the realm hierarchy. A node with no parents is an orphan. While all realm `Ids` are known to the hierarchy, an orphan does not appear in the hierarchy unless explicitly added as a root node or child of another node.
Return	`osid.personnel.RealmList`		the root realms
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method is must be implemented.
Method	hasParentRealms
Description	Tests if the `Realm` has any parents.
Parameters	`osid.id.Id`	`realmId`	a realm `Id`
Return	`boolean`		`true` if the realm has parents, f `alse` otherwise
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	isParentOfRealm
Description	Tests if an `Id` is a direct parent of realm.
Parameters	`osid.id.Id`	`id`	an `Id`
Parameters	`osid.id.Id`	`realmId`	the `Id` of a realm
Return	`boolean`		`true` if this `id` is a parent of `realmId,` f `alse` otherwise
Errors	NOT_FOUND		`realmId` is not found
	NULL_ARGUMENT		`id` or `realmId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Provider Notes	If `id` not found return `false.`
Method	getParentRealmIds
Description	Gets the parent `Ids` of the given realm.
Parameters	`osid.id.Id`	`realmId`	a realm `Id`
Return	`osid.id.IdList`		the parent `Ids` of the 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	getParentRealms
Description	Gets the parent realms of the given `id.`
Parameters	`osid.id.Id`	`realmId`	the `Id` of the `Realm` to query
Return	`osid.personnel.RealmList`		the parent realms of the `id`
Errors	NOT_FOUND		a `Realm` identified by `Id 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	isAncestorOfRealm
Description	Tests if an `Id` is an ancestor of a realm.
Parameters	`osid.id.Id`	`id`	an `Id`
Parameters	`osid.id.Id`	`realmId`	the `Id` of a realm
Return	`boolean`		`tru` e if this `id` is an ancestor of `realmId,` `false` otherwise
Errors	NOT_FOUND		`realmId` is not found
	NULL_ARGUMENT		`id` or `realmId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Provider Notes	If `id` not found return `false.`
Method	hasChildRealms
Description	Tests if a realm has any children.
Parameters	`osid.id.Id`	`realmId`	a realm `Id`
Return	`boolean`		`true` if the `realmId` has children, `false` otherwise
Errors	NOT_FOUND		`realmId` is not found
	NULL_ARGUMENT		`borealmId is null okId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	isChildOfRealm
Description	Tests if a realm is a direct child of another.
Parameters	`osid.id.Id`	`id`	an `Id`
Parameters	`osid.id.Id`	`realmId`	the `Id` of a realm
Return	`boolean`		`true` if the `id` is a child of `realmId,` `false` otherwise
Errors	NOT_FOUND		`realmId` is not found
	NULL_ARGUMENT		`id` or `realmId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Provider Notes	If `id` not found return `false.`
Method	getChildRealmIds
Description	Gets the child `Ids` of the given realm.
Parameters	`osid.id.Id`	`realmId`	the `Id` to query
Return	`osid.id.IdList`		the children of the 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	getChildRealms
Description	Gets the child realms of the given `id.`
Parameters	`osid.id.Id`	`realmId`	the `Id` of the `Realm` to query
Return	`osid.personnel.RealmList`		the child realms of the `id`
Errors	NOT_FOUND		a `Realm` identified by `Id 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	isDescendantOfRealm
Description	Tests if an `Id` is a descendant of a realm.
Parameters	`osid.id.Id`	`id`	an `Id`
Parameters	`osid.id.Id`	`realmId`	the `Id` of a realm
Return	`boolean`		`true` if the `id` is a descendant of the `realmId,` `false` otherwise
Errors	NOT_FOUND		`realmId` is not found
	NULL_ARGUMENT		`id` or `realmId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Provider Notes	If `id` is not found return `false.`
Method	getRealmNodeIds
Description	Gets a portion of the hierarchy for the given realm.
Parameters	`osid.id.Id`	`realmId`	the `Id` to query
	`cardinal`	`ancestorLevels`	the maximum number of ancestor levels to include. A value of 0 returns no parents in the node.
	`cardinal`	`descendantLevels`	the maximum number of descendant levels to include. A value of 0 returns no children in the node.
	`boolean`	`includeSiblings`	`true` to include the siblings of the given node, `false` to omit the siblings
Return	`osid.hierarchy.Node`		a realm node
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	getRealmNodes
Description	Gets a portion of the hierarchy for the given realm.
Parameters	`osid.id.Id`	`realmId`	the `Id` to query
	`cardinal`	`ancestorLevels`	the maximum number of ancestor levels to include. A value of 0 returns no parents in the node.
	`cardinal`	`descendantLevels`	the maximum number of descendant levels to include. A value of 0 returns no children in the node.
	`boolean`	`includeSiblings`	`true` to include the siblings of the given node, `false` to omit the siblings
Return	`osid.personnel.RealmNode`		a realm node
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.