OSID - osid.search.EngineHierarchySession Service Interface Definition

Interface	osid.search.EngineHierarchySession
Implements	`osid.OsidSession`
Description	This session defines methods for traversing a hierarchy of `Engine` objects. Each node in the hierarchy is a unique `Engine.` The hierarchy may be traversed recursively to establish the tree structure through `getParentEngines()` and `getChildEngines().` To relate these `Ids` to another OSID, `getEngienNodes()` can be used for retrievals that can be used for bulk lookups in other OSIDs. Any `Engine` available in the Rule 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 `getParentEngines()` or `getChildEngines()` 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: engine elements may be silently omitted or re-ordered plenary view: provides a complete set or is an error condition
Method	getEngineHierarchyId
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	getEngineHierarchy
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	canAccessEngineHierarchy
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 an application that may wish not to offer traversal operations to unauthorized users.
Return	`boolean`		`false` if hierarchy traversal methods are not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	useComparativeEngineView
Description	The returns from the engine 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	usePlenaryEngineView
Description	A complete view of the `Engine` 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	getRootEngineIds
Description	Gets the root engine `Ids` in this hierarchy.
Return	`osid.id.IdList`		the root engine `Ids`
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getRootEngines
Description	Gets the root engines in this engine hierarchy.
Return	`osid.search.EngineList`		the root engines
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method is must be implemented.
Method	hasParentEngines
Description	Tests if the `Engine` has any parents.
Parameters	`osid.id.Id`	`engineId`	the `Id` of an engine
Return	`boolean`		`true` if the engine has parents, `false` otherwise
Errors	NOT_FOUND		`engineId` is not found
	NULL_ARGUMENT		`engineId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	isParentOfEngine
Description	Tests if an `Id` is a direct parent of an engine.
Parameters	`osid.id.Id`	`id`	an `Id`
Parameters	`osid.id.Id`	`engineId`	the `Id` of an egine
Return	`boolean`		`true` if this `id` is a parent of `engineId,` `false` otherwise
Errors	NOT_FOUND		`engineId` is not found
	NULL_ARGUMENT		`id` or `engineId` 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	getParentEngineIds
Description	Gets the parent `Ids` of the given engine
Parameters	`osid.id.Id`	`engineId`	the `Id` of an egine
Return	`osid.id.IdList`		the parent `Ids` of the engine
Errors	NOT_FOUND		`engineId` is not found
	NULL_ARGUMENT		`engineId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getParentEngines
Description	Gets the parent engines of the given `id.`
Parameters	`osid.id.Id`	`engineId`	the `Id` of the `Engine` to query
Return	`osid.search.EngineList`		the parent engines of the `id`
Errors	NOT_FOUND		an `Engine` identified by `Id is` not found
	NULL_ARGUMENT		`engineId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	isAncestorOfEngine
Description	Tests if an `Id` is an ancestor of an engine.
Parameters	`osid.id.Id`	`id`	an `Id`
Parameters	`osid.id.Id`	`engineId`	the `Id` of an engine
Return	`boolean`		`true` if this `id` is an ancestor of `engineId,` `false` otherwise
Errors	NOT_FOUND		`engineId` is not found
	NULL_ARGUMENT		`id` or `engineId` 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	hasChildEngines
Description	Tests if an engine has any children.
Parameters	`osid.id.Id`	`engineId`	the `Id` of an engine
Return	`boolean`		`true` if the `engineId` has children, `false` otherwise
Errors	NOT_FOUND		`engineId` is not found
	NULL_ARGUMENT		`engineId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	isChildOfEngine
Description	Tests if an engine is a direct child of another.
Parameters	`osid.id.Id`	`id`	an `Id`
Parameters	`osid.id.Id`	`engineId`	the `Id` of an engine
Return	`boolean`		`true` if the `id` is a child of `engineId,` `false` otherwise
Errors	NOT_FOUND		`engineId` is not found
	NULL_ARGUMENT		`id` or `engineId` 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	getChildEngineIds
Description	Gets the child `Ids` of the given engine.
Parameters	`osid.id.Id`	`engineId`	the `Id` to query
Return	`osid.id.IdList`		the children of the engine
Errors	NOT_FOUND		`engineId` is not found
	NULL_ARGUMENT		`engineId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getChildEngines
Description	Gets the child engines of the given `id.`
Parameters	`osid.id.Id`	`engineId`	the `Id` of the `Engine` to query
Return	`osid.search.EngineList`		the child engines of the `id`
Errors	NOT_FOUND		an `Engine` identified by `Id is` not found
	NULL_ARGUMENT		`engineId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	isDescendantOfEngine
Description	Tests if an `Id` is a descendant of an egine.
Parameters	`osid.id.Id`	`id`	an `Id`
Parameters	`osid.id.Id`	`engineId`	the `Id` of an engine
Return	`boolean`		`true` if the `id` is a descendant of the `engineId,` `false` otherwise
Errors	NOT_FOUND		`engineId` is not found
	NULL_ARGUMENT		`id` or `engineId` 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	getEngineNodeIds
Description	Gets a portion of the hierarchy for the given engine.
Parameters	`osid.id.Id`	`engineId`	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 engine node
Errors	NOT_FOUND		`engineId` is not found
	NULL_ARGUMENT		`engineId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getEngineNodes
Description	Gets a portion of the hierarchy for the given engine.
Parameters	`osid.id.Id`	`engineId`	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.search.EngineNode`		an engine node
Errors	NOT_FOUND		`engineId` is not found
	NULL_ARGUMENT		`engineId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.