OSID - osid.configuration.ConfigurationHierarchySession Service Interface Definition

Interface	osid.configuration.ConfigurationHierarchySession
Implements	`osid.OsidSession`
Description	This session defines methods for traversing a hierarchy of `Configuration` objects. Each node in the hierarchy is a unique `Configuration.` The hierarchy may be traversed recursively to establish the tree structure through `getParentConfigurations()` and `getChildConfigurations().` To relate these `Ids` to another OSID, `getConfigurationNodes()` can be used for retrievals that can be used for bulk lookups in other OSIDs. Any `Configuration` available in the Configuration 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 `getParentConfigurationss()` or `getChildConfigurations()` 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: configuration elements may be silently omitted or re-ordered plenary view: provides a complete set or is an error condition
Method	getConfigurationHierarchyId
Description	Gets the hierarchy `Id` associated with this session.
Return	`osid.id.Id`		the configuration `Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getConfigurationHierarchy
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	canAccessConfigurationHierarchy
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	useComparativeConfigurationView
Description	The returns from the configuration 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	usePlenaryConfigurationView
Description	A complete view of the `Configuration` 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	getRootConfigurationIds
Description	Gets the root configuration `Ids` in this hierarchy.
Return	`osid.id.IdList`		the root configuration `Ids`
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getRootConfigurations
Description	Gets the root configurations in the configuration hierarchy. A node with no parents is an orphan. While all configuration `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.
Return	`osid.configuration.ConfigurationList`		the root configurations
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method is must be implemented.
Method	hasParentConfigurations
Description	Tests if the `Configuration` has any parents.
Parameters	`osid.id.Id`	`configurationId`	a configuration Id
Return	`boolean`		`true` if the configuration has parents, f `alse` otherwise
Errors	NOT_FOUND		`configurationId` is not found
	NULL_ARGUMENT		`configurationId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	isParentOfConfiguration
Description	Tests if an `Id` is a direct parent of configuration.
Parameters	`osid.id.Id`	`id`	an `Id`
Parameters	`osid.id.Id`	`configurationId`	a configuration Id
Return	`boolean`		`true` if this `id` is a parent of `configurationId,` f `alse` otherwise
Errors	NOT_FOUND		`configurationId` is not found
	NULL_ARGUMENT		`id` or `configurationId` 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	getParentConfigurationIds
Description	Gets the parent `Ids` of the given configuration.
Parameters	`osid.id.Id`	`configurationId`	a configuration Id
Return	`osid.id.IdList`		the parent Ids of the configuration
Errors	NOT_FOUND		`configurationId` is not found
	NULL_ARGUMENT		`configurationId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getParentConfigurations
Description	Gets the parents of the given configuration.
Parameters	`osid.id.Id`	`configurationId`	the `Id` to query
Return	`osid.configuration.ConfigurationList`		the parents of the configuration
Errors	NOT_FOUND		`configurationId` not found
	NULL_ARGUMENT		`configurationId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	isAncestorOfConfiguration
Description	Tests if an Id is an ancestor of a configuration.
Parameters	`osid.id.Id`	`id`	an `Id`
Parameters	`osid.id.Id`	`configurationId`	the `Id` of a configuration
Return	`boolean`		`tru` e if this `id` is an ancestor of `configurationId,` `false` otherwise
Errors	NOT_FOUND		`configurationId` is not found
	NULL_ARGUMENT		`id` or `configurationId` 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	hasChildConfigurations
Description	Tests if a configuration has any children.
Parameters	`osid.id.Id`	`configurationId`	a `configurationId`
Return	`boolean`		`true` if the `configurationId` has children, `false` otherwise
Errors	NOT_FOUND		`configurationId` not found
	NULL_ARGUMENT		`configurationId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	isChildOfConfiguration
Description	Tests if a node is a direct child of another.
Parameters	`osid.id.Id`	`id`	an `Id`
Parameters	`osid.id.Id`	`configurationId`	the `Id` of a configuration
Return	`boolean`		`true` if the `id` is a child of `configurationId,` `false` otherwise
Errors	NOT_FOUND		`configurationId` not found
	NULL_ARGUMENT		`id` or `configurationId` 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	getChildConfigurationIds
Description	Gets the child `Ids` of the given configuration.
Parameters	`osid.id.Id`	`configurationId`	the `Id` to query
Return	`osid.id.IdList`		the children of the configuration
Errors	NOT_FOUND		`configurationId` is not found
	NULL_ARGUMENT		`configurationId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getChildConfigurations
Description	Gets the children of the given configuration.
Parameters	`osid.id.Id`	`configurationId`	the `Id` to query
Return	`osid.configuration.ConfigurationList`		the children of the configuration
Errors	NOT_FOUND		`configurationId` not found
	NULL_ARGUMENT		`configurationId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	isDescendantOfConfiguration
Description	Tests if an `Id` is a descendant of a configuration.
Parameters	`osid.id.Id`	`id`	an `Id`
Parameters	`osid.id.Id`	`configurationId`	the `Id` of a configuration
Return	`boolean`		`true` if the `id` is a descendant of the `configurationId,` `false` otherwise
Errors	NOT_FOUND		`configurationId` is not found
	NULL_ARGUMENT		`id` or `configurationId` 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	getConfigurationNodeIds
Description	Gets a portion of the hierarchy for the given configuration.
Parameters	`osid.id.Id`	`configurationId`	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 configuration node
Errors	NOT_FOUND		`configurationId` not found
	NULL_ARGUMENT		`configurationId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getConfigurationNodes
Description	Gets a portion of the hierarchy for the given configuration.
Parameters	`osid.id.Id`	`configurationId`	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.configuration.ConfigurationNode`		a configuration node
Errors	NOT_FOUND		`configurationId` not found
	NULL_ARGUMENT		`configurationId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.