OSID - osid.profile.ProfileHierarchySession Service Interface Definition

Interface	osid.profile.ProfileHierarchySession
Implements	`osid.OsidSession`
Description	This session defines methods for traversing a hierarchy of `Profile` objects. Each node in the hierarchy is a unique `Profile.` The hierarchy may be traversed recursively to establish the tree structure through `getParentProfiles()` and `getChildProfiles().` To relate these `Ids` to another OSID, `getProfileNodes()` can be used for retrievals that can be used for bulk lookups in other OSIDs. Any `Profile` available in the ProfileEntry 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 `getParentProfiles()` or `getChildProfiles()` 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: profile elements may be silently omitted or re-ordered plenary view: provides a complete set or is an error condition
Method	getProfileHierarchyId
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	getProfileHierarchy
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	canAccessProfileHierarchy
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 lookup operations.
Return	`boolean`		`false` if hierarchy traversal methods are not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	useComparativeProfileView
Description	The returns from the profile 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	usePlenaryProfileView
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	getRootProfileIds
Description	Gets the root profile `Ids` in this hierarchy.
Return	`osid.id.IdList`		the root profile `Ids`
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getRootProfiles
Description	Gets the root profiles in this profile hierarchy.
Return	`osid.profile.ProfileList`		the root profiles
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method is must be implemented.
Method	hasParentProfiles
Description	Tests if the `Profile` has any parents.
Parameters	`osid.id.Id`	`profileId`	a profile `Id`
Return	`boolean`		`true` if the profile has parents, `false` otherwise
Errors	NOT_FOUND		`profileId` is not found
	NULL_ARGUMENT		`profileId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	isParentOfProfile
Description	Tests if an `Id` is a direct parent of a profile.
Parameters	`osid.id.Id`	`id`	an `Id`
Parameters	`osid.id.Id`	`profileId`	the `Id` of a profile
Return	`boolean`		`true` if this `id` is a parent of `profileId,` `false` otherwise
Errors	NOT_FOUND		`profileId` is not found
	NULL_ARGUMENT		`id` or `profileId` 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	getParentProfileIds
Description	Gets the parent `Ids` of the given profile.
Parameters	`osid.id.Id`	`profileId`	a profile `Id`
Return	`osid.id.IdList`		the parent `Ids` of the profile
Errors	NOT_FOUND		`profileId` is not found
	NULL_ARGUMENT		`profileId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getParentProfiles
Description	Gets the parents of the given profile.
Parameters	`osid.id.Id`	`profileId`	a profile `Id`
Return	`osid.profile.ProfileList`		the parents of the profile
Errors	NOT_FOUND		`profileId` is not found
	NULL_ARGUMENT		`profileId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	isAncestorOfProfile
Description	Tests if an `Id` is an ancestor of a profile.
Parameters	`osid.id.Id`	`id`	an `Id`
Parameters	`osid.id.Id`	`profileId`	the `Id` of a profile
Return	`boolean`		`true` if this `id` is an ancestor of `profileId,` `false` otherwise
Errors	NOT_FOUND		`profileId` is not found
	NULL_ARGUMENT		`profileId` or `id` 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	hasChildProfiles
Description	Tests if a profile has any children.
Parameters	`osid.id.Id`	`profileId`	a `profileId`
Return	`boolean`		`true` if the `profileId` has children, `false` otherwise
Errors	NOT_FOUND		`profileId` is not found
	NULL_ARGUMENT		`profileId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	isChildOfProfile
Description	Tests if a profile is a direct child of another.
Parameters	`osid.id.Id`	`id`	an `Id`
Parameters	`osid.id.Id`	`profileId`	the `Id` of a profile
Return	`boolean`		`true` if the `id` is a child of `profileId,` `false` otherwise
Errors	NOT_FOUND		`profileId` not found
	NULL_ARGUMENT		`profileId` or `id` 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	getChildProfileIds
Description	Gets the child `Ids` of the given profile.
Parameters	`osid.id.Id`	`profileId`	the `Id` to query
Return	`osid.id.IdList`		the children of the profile
Errors	NOT_FOUND		`profileId` is not found
	NULL_ARGUMENT		`profileId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getChildProfiles
Description	Gets the children of the given profile.
Parameters	`osid.id.Id`	`profileId`	the `Id` to query
Return	`osid.profile.ProfileList`		the children of the profile
Errors	NOT_FOUND		`profileId` is not found
	NULL_ARGUMENT		`profileId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	isDescendantOfProfile
Description	Tests if an `Id` is a descendant of a profile.
Parameters	`osid.id.Id`	`id`	an `Id`
Parameters	`osid.id.Id`	`profileId`	the `Id` of a profile
Return	`boolean`		`true` if the `id` is a descendant of the `profileId,` `false` otherwise
Errors	NOT_FOUND		`profileId` not found
	NULL_ARGUMENT		`profileId` or `id` 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	getProfileNodeIds
Description	Gets a portion of the hierarchy for the given profile.
Parameters	`osid.id.Id`	`profileId`	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`		a profile node
Errors	NOT_FOUND		`profileId` is not found
	NULL_ARGUMENT		`profileId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getProfileNodes
Description	Gets a portion of the hierarchy for the given profile.
Parameters	`osid.id.Id`	`profileId`	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.profile.ProfileNode`		a profile node
Errors	NOT_FOUND		`profileId` is not found
	NULL_ARGUMENT		`profileId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.