Interface ActivityHierarchySession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface ActivityHierarchySession
extends OsidSession

This session defines methods for traversing a hierarchy of Activities . Each node in the hierarchy is a unique Activity . The hierarchy may be traversed recursively to establish the tree structure through getActivityNodes() . To relate these Ids to another OSID, getAncestorActivities() and getDescendantActivities() can be used for retrievals that can be used for bulk lookups in other OSIDs. Any Activity available in the Business 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 getParentActivities() or getChildActivities() 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: activity 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	canAccessActivityHierarchy()	Tests if this user can perform hierarchy queries.
Hierarchy	getActivityHierarchy()	Gets the hierarchy associated with this session.
Id	getActivityHierarchyId()	Gets the hierarchy Id associated with this session.
Node	getActivityNodeIds(Id activityId, long ancestorLevels, long descendantLevels, boolean includeSiblings)	Gets a portion of the hierarchy for the given activity.
ActivityNode	getActivityNodes(Id activityId, long ancestorLevels, long descendantLevels, boolean includeSiblings)	Gets a portion of the hierarchy for the given activity.
ActivityList	getChildActivities(Id activityId)	Gets the children of the given activity.
IdList	getChildActivityIds(Id activityId)	Gets the child Ids of the given activity.
ActivityList	getParentActivities(Id activityId)	Gets the parents of the given activity.
IdList	getParentActivityIds(Id activityId)	Gets the parent Ids of the given activity.
ActivityList	getRootActivities()	Gets the root activities in this activity hierarchy.
IdList	getRootActivityIds()	Gets the root activity Ids in this hierarchy.
boolean	hasChildActivities(Id activityId)	Tests if an activity has any children.
boolean	hasParentActivities(Id activityId)	Tests if the Activity has any parents.
boolean	isAncestorOfActivity(Id id, Id activityId)	Tests if an Id is an ancestor of an activity.
boolean	isChildOfActivity(Id id, Id activityId)	Tests if an activity is a direct child of another.
boolean	isDescendantOfActivity(Id id, Id activityId)	Tests if an Id is a descendant of an activity.
boolean	isParentOfActivity(Id id, Id activityId)	Tests if an Id is a direct parent of an activity.
void	useComparativeActivityView()	The returns from the activity methods may omit or translate elements based on this session, such as authorization, and not result in an error.
void	usePlenaryActivityView()	A complete view of the Hierarchy 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

getActivityHierarchyId

Id getActivityHierarchyId()

Gets the hierarchy Id associated with this session.

Returns:

the hierarchy Id associated with this session

Compliance:

mandatory - This method must be implemented.

getActivityHierarchy

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

canAccessActivityHierarchy

boolean canAccessActivityHierarchy()

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.

Returns:

false if hierarchy traversal methods are not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

useComparativeActivityView

void useComparativeActivityView()

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

usePlenaryActivityView

void usePlenaryActivityView()

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.

getRootActivityIds

IdList getRootActivityIds()
                   throws OperationFailedException,
PermissionDeniedException

Gets the root activity Ids in this hierarchy.

Returns:

the root activity Ids

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getRootActivities

ActivityList getRootActivities()
                        throws OperationFailedException,
PermissionDeniedException

Gets the root activities in this activity hierarchy.

Returns:

the root activities

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method is must be implemented.

hasParentActivities

boolean hasParentActivities(Id activityId)
                     throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if the Activity has any parents.

Parameters:

activityId - the Id of an activity

Returns:

true if the activity has parents, false otherwise

Throws:

NotFoundException - activityId is not found

NullArgumentException - activityId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

isParentOfActivity

boolean isParentOfActivity(Id id,
 Id activityId)
                    throws NotFoundException,
OperationFailedException,
PermissionDeniedException

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

Parameters:

id - an Id

activityId - the Id of an activity

Returns:

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

Throws:

NotFoundException - activityId is not found

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

getParentActivityIds

IdList getParentActivityIds(Id activityId)
                     throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the parent Ids of the given activity.

Parameters:

activityId - the Id of an activity

Returns:

the parent Ids of the activity

Throws:

NotFoundException - activityId is not found

NullArgumentException - activityId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getParentActivities

ActivityList getParentActivities(Id activityId)
                          throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the parents of the given activity.

Parameters:

activityId - the Id of an activity

Returns:

the parents of the activity

Throws:

NotFoundException - activityId is not found

NullArgumentException - activityId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

isAncestorOfActivity

boolean isAncestorOfActivity(Id id,
 Id activityId)
                      throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if an Id is an ancestor of an activity.

Parameters:

id - an Id

activityId - the Id of an activity

Returns:

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

Throws:

NotFoundException - activityId is not found

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

hasChildActivities

boolean hasChildActivities(Id activityId)
                    throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if an activity has any children.

Parameters:

activityId - the Id of an activity

Returns:

true if the activityId has children, false otherwise

Throws:

NotFoundException - activityId is not found

NullArgumentException - activityId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

isChildOfActivity

boolean isChildOfActivity(Id id,
 Id activityId)
                   throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if an activity is a direct child of another.

Parameters:

id - an Id

activityId - the Id of an activity

Returns:

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

Throws:

NotFoundException - activityId is not found

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

getChildActivityIds

IdList getChildActivityIds(Id activityId)
                    throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the child Ids of the given activity.

Parameters:

activityId - the Id to query

Returns:

the children of the activity

Throws:

NotFoundException - activityId is not found

NullArgumentException - activityId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getChildActivities

ActivityList getChildActivities(Id activityId)
                         throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the children of the given activity.

Parameters:

activityId - the Id to query

Returns:

the children of the activity

Throws:

NotFoundException - activityId is not found

NullArgumentException - activityId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

isDescendantOfActivity

boolean isDescendantOfActivity(Id id,
 Id activityId)
                        throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if an Id is a descendant of an activity.

Parameters:

id - an Id

activityId - the Id of an activity

Returns:

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

Throws:

NotFoundException - activityId is not found

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

getActivityNodeIds

Node getActivityNodeIds(Id activityId,
 long ancestorLevels,
 long descendantLevels,
 boolean includeSiblings)
                 throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets a portion of the hierarchy for the given activity.

Parameters:

activityId - 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:

an activity node

Throws:

NotFoundException - activityId is not found

NullArgumentException - activityId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getActivityNodes

ActivityNode getActivityNodes(Id activityId,
 long ancestorLevels,
 long descendantLevels,
 boolean includeSiblings)
                       throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets a portion of the hierarchy for the given activity.

Parameters:

activityId - 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:

an activity node

Throws:

NotFoundException - activityId is not found

NullArgumentException - activityId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.