OSID - osid.personnel.OrganizationHierarchySession Service Interface Definition

Interface	osid.personnel.OrganizationHierarchySession
Implements	`osid.OsidSession`
Description	This session defines methods for traversing a hierarchy of `Organization` objects. Each node in the hierarchy is a unique `Organization.` The hierarchy may be traversed recursively to establish the tree structure through `getOrganizationNodes().` To relate these `Ids` to another OSID, `getAncestorOrganizations()` and `getDescendantOrganizations()` can be used for retrievals that can be used for bulk lookups in other OSIDs. Any `Organization` 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 `getParentOrganizations()` or `getChildOrganizations()` 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: organization elements may be silently omitted or re-ordered plenary view: provides a complete set or is an error condition
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	canAccessOrganizationHierarchy
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 traversal operations.
Return	`boolean`		`false` if hierarchy traversal methods are not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	useComparativeOrganizationView
Description	The returns from the organization 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	usePlenaryOrganizationView
Description	A complete view of the `Hierarchy` 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	getRootOrganizationIds
Description	Gets the root organization `Ids` in this hierarchy.
Return	`osid.id.IdList`		the root organization `Ids`
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getRootOrganizations
Description	Gets the root organizations in this organization hierarchy.
Return	`osid.personnel.OrganizationList`		the root organizations
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method is must be implemented.
Method	hasParentOrganizations
Description	Tests if the `Organization` has any parents.
Parameters	`osid.id.Id`	`organizationId`	the `Id` of an organization
Return	`boolean`		`true` if the organization has parents, `false` otherwise
Errors	NOT_FOUND		`organizationId` is 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	isParentOfOrganization
Description	Tests if an `Id` is a direct parent of an organization.
Parameters	`osid.id.Id`	`id`	an `Id`
Parameters	`osid.id.Id`	`organizationId`	the `Id` of an organization
Return	`boolean`		`true` if this `id` is a parent of `organizationId,` `false` otherwise
Errors	NOT_FOUND		`organizationId` is not found
	NULL_ARGUMENT		`id` or `organizationId` 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	getParentOrganizationIds
Description	Gets the parent Ids of the given organization.
Parameters	`osid.id.Id`	`organizationId`	the `Id` of an organization
Return	`osid.id.IdList`		the parent `Ids` of the organization
Errors	NOT_FOUND		`organizationId` is 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	getParentOrganizations
Description	Gets the parents of the given organization.
Parameters	`osid.id.Id`	`organizationId`	the `Id` of an organization
Return	`osid.personnel.OrganizationList`		the parents of the organization
Errors	NOT_FOUND		`organizationId` is 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	isAncestorOfOrganization
Description	Tests if an `Id` is an ancestor of an organization.
Parameters	`osid.id.Id`	`id`	an `Id`
Parameters	`osid.id.Id`	`organizationId`	the `Id` of an organization
Return	`boolean`		`true` if this `id` is an ancestor of `organizationId,` `false` otherwise
Errors	NOT_FOUND		`organizationId` is not found
	NULL_ARGUMENT		`id` or `organizationId` 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	hasChildOrganizations
Description	Tests if an organization has any children.
Parameters	`osid.id.Id`	`organizationId`	the `Id` of an organization
Return	`boolean`		`true` if the `organizationId` has children, `false` otherwise
Errors	NOT_FOUND		`organizationId` is 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	isChildOfOrganization
Description	Tests if an organization is a direct child of another.
Parameters	`osid.id.Id`	`id`	an `Id`
Parameters	`osid.id.Id`	`organizationId`	the `Id` of an organization
Return	`boolean`		`true` if the `id` is a child of `organizationId,` `false` otherwise
Errors	NOT_FOUND		`organizationId` is not found
	NULL_ARGUMENT		`id` or `organizationId` 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	getChildOrganizationIds
Description	Gets the child `Ids` of the given organization.
Parameters	`osid.id.Id`	`organizationId`	the `Id` to query
Return	`osid.id.IdList`		the children of the organization
Errors	NOT_FOUND		`organizationId` is 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	getChildOrganizations
Description	Gets the children of the given organization.
Parameters	`osid.id.Id`	`organizationId`	the `Id` to query
Return	`osid.personnel.OrganizationList`		the children of the organization
Errors	NOT_FOUND		`organizationId` is 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	isDescendantOfOrganization
Description	Tests if an `Id` is a descendant of an organization.
Parameters	`osid.id.Id`	`id`	an `Id`
Parameters	`osid.id.Id`	`organizationId`	the `Id` of an organization
Return	`boolean`		`true` if the `id` is a descendant of the `organizationId,` `false` otherwise
Errors	NOT_FOUND		`organizationId` is not found
	NULL_ARGUMENT		`id` or `organizationId` 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	getOrganizationNodeIds
Description	Gets a portion of the hierarchy for the given organization.
Parameters	`osid.id.Id`	`organizationId`	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`		an organization node
Errors	NOT_FOUND		`organizationId` is 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	getOrganizationNodes
Description	Gets a portion of the hierarchy for the given organization.
Parameters	`osid.id.Id`	`organizationId`	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.OrganizationNode`		an organization node
Errors	NOT_FOUND		`organizationId` is not found
	NULL_ARGUMENT		`organizationId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.