Interface UtilityHierarchySession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface UtilityHierarchySession
extends OsidSession

This session defines methods for traversing a hierarchy of Utility objects. Each node in the hierarchy is a unique Utility . The hierarchy may be traversed recursively to establish the tree structure through getParentUtilities() and getChildUtilities() . To relate these Ids to another OSID, getUtilityNodes() can be used for retrievals that can be used for bulk lookups in other OSIDs. Any Utility available in the Utility 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 getParentUtilities() or getChildUtilities() 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: utility 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	canAccessUtilityHierarchy()	Tests if this user can perform hierarchy queries.
UtilityList	getChildUtilities(Id utilityId)	Gets the child utilities of the given id .
IdList	getChildUtilityIds(Id utilityId)	Gets the child Ids of the given utility.
UtilityList	getParentUtilities(Id utilityId)	Gets the parent utilities of the given id .
IdList	getParentUtilityIds(Id utilityId)	Gets the parent Ids of the given utility.
UtilityList	getRootUtilities()	Gets the root utilities in the utility hierarchy.
IdList	getRootUtilityIds()	Gets the root utility Ids in this hierarchy.
Hierarchy	getUtilityHierarchy()	Gets the hierarchy associated with this session.
Id	getUtilityHierarchyId()	Gets the hierarchy Id associated with this session.
Node	getUtilityNodeIds(Id utilityId, long ancestorLevels, long descendantLevels, boolean includeSiblings)	Gets a portion of the hierarchy for the given utility.
UtilityNode	getUtilityNodes(Id utilityId, long ancestorLevels, long descendantLevels, boolean includeSiblings)	Gets a portion of the hierarchy for the given utility.
boolean	hasChildUtilities(Id utilityId)	Tests if a utility has any children.
boolean	hasParentUtilities(Id utilityId)	Tests if the Utility has any parents.
boolean	isAncestorOfUtility(Id id, Id utilityId)	Tests if an Id is an ancestor of a utility.
boolean	isChildOfUtility(Id id, Id utilityId)	Tests if a utility is a direct child of another.
boolean	isDescendantOfUtility(Id id, Id utilityId)	Tests if an Id is a descendant of a utility.
boolean	isParentOfUtility(Id id, Id utilityId)	Tests if an Id is a direct parent of a utility.
void	useComparativeUtilityView()	The returns from the utility methods may omit or translate elements based on this session, such as authorization, and not result in an error.
void	usePlenaryUtilityView()	A complete view of the Utility 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

getUtilityHierarchyId

Id getUtilityHierarchyId()

Gets the hierarchy Id associated with this session.

Returns:

the hierarchy Id associated with this session

Compliance:

mandatory - This method must be implemented.

getUtilityHierarchy

Hierarchy getUtilityHierarchy()
                       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.

canAccessUtilityHierarchy

boolean canAccessUtilityHierarchy()

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.

useComparativeUtilityView

void useComparativeUtilityView()

The returns from the utility 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.

usePlenaryUtilityView

void usePlenaryUtilityView()

A complete view of the Utility 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.

getRootUtilityIds

IdList getRootUtilityIds()
                  throws OperationFailedException,
PermissionDeniedException

Gets the root utility Ids in this hierarchy.

Returns:

the root utility Ids

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getRootUtilities

UtilityList getRootUtilities()
                      throws OperationFailedException,
PermissionDeniedException

Gets the root utilities in the utility hierarchy. A node with no parents is an orphan. While all utility 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 utilities

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method is must be implemented.

hasParentUtilities

boolean hasParentUtilities(Id utilityId)
                    throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if the Utility has any parents.

Parameters:

utilityId - the Id of a utility

Returns:

true if the utility has parents, false otherwise

Throws:

NotFoundException - utilityId is not found

NullArgumentException - utilityId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

isParentOfUtility

boolean isParentOfUtility(Id id,
 Id utilityId)
                   throws NotFoundException,
OperationFailedException,
PermissionDeniedException

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

Parameters:

id - an Id

utilityId - the Id of a utility

Returns:

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

Throws:

NotFoundException - utilityId is not found

NullArgumentException - id or utilityId 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} .

getParentUtilityIds

IdList getParentUtilityIds(Id utilityId)
                    throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the parent Ids of the given utility.

Parameters:

utilityId - the Id of a utility

Returns:

the parent Ids of the utility

Throws:

NotFoundException - utilityId is not found

NullArgumentException - utilityId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getParentUtilities

UtilityList getParentUtilities(Id utilityId)
                        throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the parent utilities of the given id .

Parameters:

utilityId - the Id of the Utility to query

Returns:

the parent utilities of the id

Throws:

NotFoundException - a Utility identified by Id is not found

NullArgumentException - utilityId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

isAncestorOfUtility

boolean isAncestorOfUtility(Id id,
 Id utilityId)
                     throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if an Id is an ancestor of a utility.

Parameters:

id - an Id

utilityId - the Id of a utility

Returns:

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

Throws:

NotFoundException - utilityId is not found

NullArgumentException - id or utilityId 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} .

hasChildUtilities

boolean hasChildUtilities(Id utilityId)
                   throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if a utility has any children.

Parameters:

utilityId - the Id of a utility

Returns:

true if the utilityId has children, false otherwise

Throws:

NotFoundException - utilityId is not found

NullArgumentException - utilityId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

isChildOfUtility

boolean isChildOfUtility(Id id,
 Id utilityId)
                  throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if a utility is a direct child of another.

Parameters:

id - an Id

utilityId - the Id of a utility

Returns:

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

Throws:

NotFoundException - utilityId is not found

NullArgumentException - id or utilityId 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} .

getChildUtilityIds

IdList getChildUtilityIds(Id utilityId)
                   throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the child Ids of the given utility.

Parameters:

utilityId - the Id to query

Returns:

the children of the utility

Throws:

NotFoundException - utilityId is not found

NullArgumentException - utilityId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getChildUtilities

UtilityList getChildUtilities(Id utilityId)
                       throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the child utilities of the given id .

Parameters:

utilityId - the Id of the Utility to query

Returns:

the child utilities of the id

Throws:

NotFoundException - a Utility identified by Id is not found

NullArgumentException - utilityId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

isDescendantOfUtility

boolean isDescendantOfUtility(Id id,
 Id utilityId)
                       throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if an Id is a descendant of a utility.

Parameters:

id - an Id

utilityId - the Id of a utility

Returns:

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

Throws:

NotFoundException - utilityId is not found

NullArgumentException - id or utilityId 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} .

getUtilityNodeIds

Node getUtilityNodeIds(Id utilityId,
 long ancestorLevels,
 long descendantLevels,
 boolean includeSiblings)
                throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets a portion of the hierarchy for the given utility.

Parameters:

utilityId - 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 utility node

Throws:

NotFoundException - utilityId is not found

NullArgumentException - utilityId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getUtilityNodes

UtilityNode getUtilityNodes(Id utilityId,
 long ancestorLevels,
 long descendantLevels,
 boolean includeSiblings)
                     throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets a portion of the hierarchy for the given utility.

Parameters:

utilityId - 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 utility node

Throws:

NotFoundException - utilityId is not found

NullArgumentException - utilityId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.