Interface FamilyHierarchySession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface FamilyHierarchySession
extends OsidSession

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 Summary

Modifier and Type	Method	Description
boolean	canAccessFamilyHierarchy()	Tests if this user can perform hierarchy queries.
FamilyList	getChildFamilies(Id familyId)	Gets the child families of the given id .
IdList	getChildFamilyIds(Id familyId)	Gets the child Ids of the given family.
Hierarchy	getFamilyHierarchy()	Gets the hierarchy associated with this session.
Id	getFamilyHierarchyId()	Gets the hierarchy Id associated with this session.
Node	getFamilyNodeIds(Id familyId, long ancestorLevels, long descendantLevels, boolean includeSiblings)	Gets a portion of the hierarchy for the given family.
FamilyNode	getFamilyNodes(Id familyId, long ancestorLevels, long descendantLevels, boolean includeSiblings)	Gets a portion of the hierarchy for the given family.
FamilyList	getParentFamilies(Id familyId)	Gets the parent families of the given id .
IdList	getParentFamilyIds(Id familyId)	Gets the parent Ids of the given family.
FamilyList	getRootFamilies()	Gets the root families in the family hierarchy.
IdList	getRootFamilyIds()	Gets the root family Ids in this hierarchy.
boolean	hasChildFamilies(Id familyId)	Tests if a family has any children.
boolean	hasParentFamilies(Id familyId)	Tests if the Family has any parents.
boolean	isAncestorOfFamily(Id id, Id familyId)	Tests if an Id is an ancestor of a family.
boolean	isChildOfFamily(Id id, Id familyId)	Tests if a family is a direct child of another.
boolean	isDescendantOfFamily(Id id, Id familyId)	Tests if an Id is a descendant of a family.
boolean	isParentOfFamily(Id id, Id familyId)	Tests if an Id is a direct parent of a family.
void	useComparativeFamilyView()	The returns from the family methods may omit or translate elements based on this session, such as authorization, and not result in an error.
void	usePlenaryFamilyView()	A complete view of the Family returns is desired.

Methods inherited from interface Closeable

close

Methods inherited from interface OsidSession

close

Modifier and Type	Method	Description
void	close()	Close this session.

Methods inherited from interface OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Modifier and Type	Method	Description
Agent	getAuthenticatedAgent()	Gets the agent authenticated to this session.
Id	getAuthenticatedAgentId()	Gets the Id of the agent authenticated to this session.
BigDecimal	getClockRate()	Gets the rate of the service clock.
Date	getDate()	Gets the service date which may be the current date or the effective date in which this session exists.
Agent	getEffectiveAgent()	Gets the effective agent in use by this session.
Id	getEffectiveAgentId()	Gets the Id of the effective agent in use by this session.
Type	getFormatType()	Gets the DisplayText format Type preference in effect for this session.
Locale	getLocale()	Gets the locale indicating the localization preferences in effect for this session.
boolean	isAuthenticated()	Tests if an agent is authenticated to this session.
Transaction	startTransaction()	Starts a new transaction for this sesson.
boolean	supportsTransactions()	Tests for the availability of transactions.

Method Details

getFamilyHierarchyId

Id getFamilyHierarchyId()

Gets the hierarchy Id associated with this session.

Returns:

the hierarchy Id associated with this session

Compliance:

mandatory - This method must be implemented.

getFamilyHierarchy

Hierarchy getFamilyHierarchy()
                      throws OperationFailedException,
PermissionDeniedException

Gets the hierarchy associated with this session.

Returns:

the hierarchy associated with this session

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canAccessFamilyHierarchy

boolean canAccessFamilyHierarchy()

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.

Returns:

false if hierarchy traversal methods are not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

useComparativeFamilyView

void useComparativeFamilyView()

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.

usePlenaryFamilyView

void usePlenaryFamilyView()

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.

getRootFamilyIds

IdList getRootFamilyIds()
                 throws OperationFailedException,
PermissionDeniedException

Gets the root family Ids in this hierarchy.

Returns:

the root family Ids

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getRootFamilies

FamilyList getRootFamilies()
                    throws OperationFailedException,
PermissionDeniedException

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.

Returns:

the root families

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method is must be implemented.

hasParentFamilies

boolean hasParentFamilies(Id familyId)
                   throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if the Family has any parents.

Parameters:

familyId - the Id of a family

Returns:

true if the family has parents, false otherwise

Throws:

NotFoundException - familyId is not found

NullArgumentException - familyId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

isParentOfFamily

boolean isParentOfFamily(Id id,
 Id familyId)
                  throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if an Id is a direct parent of a family.

Parameters:

id - an Id

familyId - the Id of a family

Returns:

true if this id is a parent of familyId , false otherwise

Throws:

NotFoundException - familyId is not found

NullArgumentException - id or familyId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

Notes:

If - {@code id} not found return {@code false} .

getParentFamilyIds

IdList getParentFamilyIds(Id familyId)
                   throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the parent Ids of the given family.

Parameters:

familyId - the Id of a family

Returns:

the parent Ids of the family

Throws:

NotFoundException - familyId is not found

NullArgumentException - familyId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getParentFamilies

FamilyList getParentFamilies(Id familyId)
                      throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the parent families of the given id .

Parameters:

familyId - the Id of the Family to query

Returns:

the parent families of the id

Throws:

NotFoundException - a Family identified by Id is not found

NullArgumentException - familyId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

isAncestorOfFamily

boolean isAncestorOfFamily(Id id,
 Id familyId)
                    throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if an Id is an ancestor of a family.

Parameters:

id - an Id

familyId - the Id of a family

Returns:

true if this id is an ancestor of familyId , false otherwise

Throws:

NotFoundException - familyId is not found

NullArgumentException - id or familyId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

Notes:

If - {@code id} not found return {@code false} .

hasChildFamilies

boolean hasChildFamilies(Id familyId)
                  throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if a family has any children.

Parameters:

familyId - the Id of a family

Returns:

true if the familyId has children, false otherwise

Throws:

NotFoundException - familyId is not found

NullArgumentException - familyId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

isChildOfFamily

boolean isChildOfFamily(Id id,
 Id familyId)
                 throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if a family is a direct child of another.

Parameters:

id - an Id

familyId - the Id of a family

Returns:

true if the id is a child of familyId , false otherwise

Throws:

NotFoundException - familyId is not found

NullArgumentException - id or familyId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

Notes:

If - {@code id} not found return {@code false} .

getChildFamilyIds

IdList getChildFamilyIds(Id familyId)
                  throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the child Ids of the given family.

Parameters:

familyId - the Id to query

Returns:

the children of the family

Throws:

NotFoundException - familyId is not found

NullArgumentException - familyId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getChildFamilies

FamilyList getChildFamilies(Id familyId)
                     throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the child families of the given id .

Parameters:

familyId - the Id of the Family to query

Returns:

the child families of the id

Throws:

NotFoundException - a Family identified by Id is not found

NullArgumentException - familyId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

isDescendantOfFamily

boolean isDescendantOfFamily(Id id,
 Id familyId)
                      throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if an Id is a descendant of a family.

Parameters:

id - an Id

familyId - the Id of a family

Returns:

true if the id is a descendant of the familyId , false otherwise

Throws:

NotFoundException - familyId is not found

NullArgumentException - id or familyId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

Notes:

If - {@code id} is not found return {@code false} .

getFamilyNodeIds

Node getFamilyNodeIds(Id familyId,
 long ancestorLevels,
 long descendantLevels,
 boolean includeSiblings)
               throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets a portion of the hierarchy for the given family.

Parameters:

familyId - the Id to query

ancestorLevels - the maximum number of ancestor levels to include. A value of 0 returns no parents in the node.

descendantLevels - the maximum number of descendant levels to include. A value of 0 returns no children in the node.

includeSiblings - true to include the siblings of the given node, false to omit the siblings

Returns:

a family node

Throws:

NotFoundException - familyId is not found

NullArgumentException - familyId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getFamilyNodes

FamilyNode getFamilyNodes(Id familyId,
 long ancestorLevels,
 long descendantLevels,
 boolean includeSiblings)
                   throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets a portion of the hierarchy for the given family.

Parameters:

familyId - the Id to query

ancestorLevels - the maximum number of ancestor levels to include. A value of 0 returns no parents in the node.

descendantLevels - the maximum number of descendant levels to include. A value of 0 returns no children in the node.

includeSiblings - true to include the siblings of the given node, false to omit the siblings

Returns:

a family node

Throws:

NotFoundException - familyId is not found

NullArgumentException - familyId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.