OSID - osid.financials.ActivityHierarchySession Service Interface Definition

Interface	osid.financials.ActivityHierarchySession
Implements	`osid.OsidSession`
Description	This session defines methods for traversing a hierarchy of `Activity` objects. 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	getActivityHierarchyId
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	getActivityHierarchy
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	canAccessActivityHierarchy
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 application that may opt not to offer traversal operations.
Return	`boolean`		`false` if hierarchy traversal methods are not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	useComparativeActivityView
Description	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.
Method	usePlenaryActivityView
Description	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.
Method	getRootActivityIds
Description	Gets the root activity `Ids` in this hierarchy.
Return	`osid.id.IdList`		the root activity `Ids`
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getRootActivities
Description	Gets the root activities in this activity hierarchy.
Return	`osid.financials.ActivityList`		the root activities
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method is must be implemented.
Method	hasParentActivities
Description	Tests if the `Activity` has any parents.
Parameters	`osid.id.Id`	`activityId`	the `Id` of an activity
Return	`boolean`		`true` if the activity has parents, `false` otherwise
Errors	NOT_FOUND		`activityId` is not found
	NULL_ARGUMENT		`activityId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	isParentOfActivity
Description	Tests if an `Id` is a direct parent of an activity.
Parameters	`osid.id.Id`	`id`	an `Id`
Parameters	`osid.id.Id`	`activityId`	the `Id` of an activity
Return	`boolean`		`true` if this `id` is a parent of `activityId,` `false` otherwise
Errors	NOT_FOUND		`activityId` is not found
	NULL_ARGUMENT		`id` or `activityId` 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	getParentActivityIds
Description	Gets the parent Ids of the given activity.
Parameters	`osid.id.Id`	`activityId`	the `Id` of an activity
Return	`osid.id.IdList`		the parent `Ids` of the activity
Errors	NOT_FOUND		`activityId` is not found
	NULL_ARGUMENT		`activityId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getParentActivities
Description	Gets the parents of the given activity.
Parameters	`osid.id.Id`	`activityId`	the `Id` of an activity
Return	`osid.financials.ActivityList`		the parents of the activity
Errors	NOT_FOUND		`activityId` is not found
	NULL_ARGUMENT		`activityId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	isAncestorOfActivity
Description	Tests if an `Id` is an ancestor of an activity.
Parameters	`osid.id.Id`	`id`	an `Id`
Parameters	`osid.id.Id`	`activityId`	the `Id` of an activity
Return	`boolean`		`true` if this `id` is an ancestor of `activityId,` `false` otherwise
Errors	NOT_FOUND		`activityId` is not found
	NULL_ARGUMENT		`id` or `activityId` 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	hasChildActivities
Description	Tests if an activity has any children.
Parameters	`osid.id.Id`	`activityId`	the `Id` of an activity
Return	`boolean`		`true` if the `activityId` has children, `false` otherwise
Errors	NOT_FOUND		`activityId` is not found
	NULL_ARGUMENT		`activityId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	isChildOfActivity
Description	Tests if an activity is a direct child of another.
Parameters	`osid.id.Id`	`id`	an `Id`
Parameters	`osid.id.Id`	`activityId`	the `Id` of an activity
Return	`boolean`		`true` if the `id` is a child of `activityId,` `false` otherwise
Errors	NOT_FOUND		`activityId` is not found
	NULL_ARGUMENT		`id` or `activityId` 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	getChildActivityIds
Description	Gets the child `Ids` of the given activity.
Parameters	`osid.id.Id`	`activityId`	the `Id` to query
Return	`osid.id.IdList`		the children of the activity
Errors	NOT_FOUND		`activityId` is not found
	NULL_ARGUMENT		`activityId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getChildActivities
Description	Gets the children of the given activity.
Parameters	`osid.id.Id`	`activityId`	the `Id` to query
Return	`osid.financials.ActivityList`		the children of the activity
Errors	NOT_FOUND		`activityId` is not found
	NULL_ARGUMENT		`activityId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	isDescendantOfActivity
Description	Tests if an `Id` is a descendant of an activity.
Parameters	`osid.id.Id`	`id`	an `Id`
Parameters	`osid.id.Id`	`activityId`	the `Id` of an activity
Return	`boolean`		`true` if the `id` is a descendant of the `activityId,` `false` otherwise
Errors	NOT_FOUND		`activityId` is not found
	NULL_ARGUMENT		`id` or `activityId` 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	getActivityNodeIds
Description	Gets a portion of the hierarchy for the given activity.
Parameters	`osid.id.Id`	`activityId`	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`		an activity node
Errors	NOT_FOUND		`activityId` is not found
	NULL_ARGUMENT		`activityId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getActivityNodes
Description	Gets a portion of the hierarchy for the given activity.
Parameters	`osid.id.Id`	`activityId`	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.financials.ActivityNode`		an activity node
Errors	NOT_FOUND		`activityId` is not found
	NULL_ARGUMENT		`activityId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.