OSID - osid.relationship.FamilyHierarchySession Service Interface Definition

Interface	osid.relationship.FamilyHierarchySession
Implements	`osid.OsidSession`
Description	This session defines methods for traversing a hierarchy of `Family` objects. Each node in the hierarchy is a unique `Family.` The hierarchy may be traversed recursively to establish the tree structure through `getParentFamilies()` and `getChildFamilies().` To relate these `Ids` to another OSID, `getFamilyNodes()` can be used for retrievals that can be used for bulk lookups in other OSIDs. Any `Family` available in the Relationship 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 `getParentFamilies()` or `getChildFamilies()` 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: family elements may be silently omitted or re-ordered plenary view: provides a complete set or is an error condition
Method	getFamilyHierarchyId
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	getFamilyHierarchy
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	canAccessFamilyHierarchy
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 an application that may not offer hierrachy traversal operations to unauthorized users.
Return	`boolean`		`false` if hierarchy traversal methods are not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	useComparativeFamilyView
Description	The returns from the family 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	usePlenaryFamilyView
Description	A complete view of the `Family` 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	getRootFamilyIds
Description	Gets the root family `Ids` in this hierarchy.
Return	`osid.id.IdList`		the root family `Ids`
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getRootFamilies
Description	Gets the root families in the family hierarchy. A node with no parents is an orphan. While all family `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.relationship.FamilyList`		the root families
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method is must be implemented.
Method	hasParentFamilies
Description	Tests if the `Family` has any parents.
Parameters	`osid.id.Id`	`familyId`	the `Id` of a family
Return	`boolean`		`true` if the family has parents, `false` otherwise
Errors	NOT_FOUND		`familyId` is not found
	NULL_ARGUMENT		`familyId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	isParentOfFamily
Description	Tests if an `Id` is a direct parent of a family.
Parameters	`osid.id.Id`	`id`	an `Id`
Parameters	`osid.id.Id`	`familyId`	the `Id` of a family
Return	`boolean`		`true` if this `id` is a parent of `familyId,` `false` otherwise
Errors	NOT_FOUND		`familyId` is not found
	NULL_ARGUMENT		`id` or `familyId` 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	getParentFamilyIds
Description	Gets the parent `Ids` of the given family.
Parameters	`osid.id.Id`	`familyId`	the `Id` of a family
Return	`osid.id.IdList`		the parent `Ids` of the family
Errors	NOT_FOUND		`familyId` is not found
	NULL_ARGUMENT		`familyId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getParentFamilies
Description	Gets the parent families of the given `id.`
Parameters	`osid.id.Id`	`familyId`	the `Id` of the `Family` to query
Return	`osid.relationship.FamilyList`		the parent families of the `id`
Errors	NOT_FOUND		a `Family` identified by `Id is` not found
	NULL_ARGUMENT		`familyId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	isAncestorOfFamily
Description	Tests if an `Id` is an ancestor of a family.
Parameters	`osid.id.Id`	`id`	an `Id`
Parameters	`osid.id.Id`	`familyId`	the `Id` of a family
Return	`boolean`		`true` if this `id` is an ancestor of `familyId,` `false` otherwise
Errors	NOT_FOUND		`familyId` is not found
	NULL_ARGUMENT		`id` or `familyId` 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	hasChildFamilies
Description	Tests if a family has any children.
Parameters	`osid.id.Id`	`familyId`	the `Id` of a family
Return	`boolean`		`true` if the `familyId` has children, `false` otherwise
Errors	NOT_FOUND		`familyId` is not found
	NULL_ARGUMENT		`familyId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	isChildOfFamily
Description	Tests if a family is a direct child of another.
Parameters	`osid.id.Id`	`id`	an `Id`
Parameters	`osid.id.Id`	`familyId`	the `Id` of a family
Return	`boolean`		`true` if the `id` is a child of `familyId,` `false` otherwise
Errors	NOT_FOUND		`familyId` is not found
	NULL_ARGUMENT		`id` or `familyId` 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	getChildFamilyIds
Description	Gets the child `Ids` of the given family.
Parameters	`osid.id.Id`	`familyId`	the `Id` to query
Return	`osid.id.IdList`		the children of the family
Errors	NOT_FOUND		`familyId` is not found
	NULL_ARGUMENT		`familyId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getChildFamilies
Description	Gets the child families of the given `id.`
Parameters	`osid.id.Id`	`familyId`	the `Id` of the `Family` to query
Return	`osid.relationship.FamilyList`		the child families of the `id`
Errors	NOT_FOUND		a `Family` identified by `Id is` not found
	NULL_ARGUMENT		`familyId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	isDescendantOfFamily
Description	Tests if an `Id` is a descendant of a family.
Parameters	`osid.id.Id`	`id`	an `Id`
Parameters	`osid.id.Id`	`familyId`	the `Id` of a family
Return	`boolean`		`true` if the `id` is a descendant of the `familyId,` `false` otherwise
Errors	NOT_FOUND		`familyId` is not found
	NULL_ARGUMENT		`id` or `familyId` 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	getFamilyNodeIds
Description	Gets a portion of the hierarchy for the given family.
Parameters	`osid.id.Id`	`familyId`	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 family node
Errors	NOT_FOUND		`familyId` is not found
	NULL_ARGUMENT		`familyId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getFamilyNodes
Description	Gets a portion of the hierarchy for the given family.
Parameters	`osid.id.Id`	`familyId`	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.relationship.FamilyNode`		a family node
Errors	NOT_FOUND		`familyId` is not found
	NULL_ARGUMENT		`familyId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.