org.osid.relationship

Interface FamilyNode

All Superinterfaces:

Containable, Identifiable, OsidNode

public interface FamilyNode
extends OsidNode

This interface is a container for a partial hierarchy retrieval. The number of hierarchy levels traversable through this interface depend on the number of levels requested in the FamilyHierarchySession.

Method Summary

Methods

Modifier and Type	Method and Description
FamilyNodeList	getChildFamilyNodes() Gets the children of this family.
Family	getFamily() Gets the Family at this node.
FamilyNodeList	getParentFamilyNodes() Gets the parents of this family.

Methods inherited from interface org.osid.OsidNode

getChildIds, getParentIds, hasChildren, hasParents, isLeaf, isRoot

Methods inherited from interface org.osid.Identifiable

getId, isCurrent

Methods inherited from interface org.osid.Containable

isSequestered

Method Detail

getFamily

Family getFamily()

Gets the Family at this node.

Returns:

the family represented by this node

Compliance:

mandatory - This method must be implemented.

getParentFamilyNodes

FamilyNodeList getParentFamilyNodes()

Gets the parents of this family.

Returns:

the parents of the id

Compliance:

mandatory - This method must be implemented.

getChildFamilyNodes

FamilyNodeList getChildFamilyNodes()

Gets the children of this family.

Returns:

the children of this family

Compliance:

mandatory - This method must be implemented.