OSID - osid.lexicon.PressHierarchySession Service Interface Definition

Interface	osid.lexicon.PressHierarchySession
Implements	`osid.OsidSession`
Used By	`osid.lexicon.LexiconManager`
Used By	`osid.lexicon.LexiconProxyManager`
Description	This session defines methods for traversing a hierarchy of `Presses`. Each node in the hierarchy is a unique `Press`. The hierarchy may be traversed recursively to establish the tree structure through `getParentPresses()` and `getChildPresses()`. To relate these `Ids` to another OSID, `getPressNodes()` can be used for retrievals that can be used for bulk lookups in other OSIDs. Any `Press` available in the Lexicon OSID is known to this hierarchy but does not appear in the hierarchy traversal until added as a root press or a child of another press. 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 `getParentPresses()` or `getChildPresses()` in lieu of a `PERMISSION_DENIED` error that may disrupt the traversal through authorized textways. This session defines views that offer differing behaviors when retrieving multiple objects. comparative press view: press elements may be silently omitted or re-ordered plenary press view: provides a complete set or is an error condition
Method	getPressHierarchyId
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	getPressHierarchy
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	canAccessPressHierarchy
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 press 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	useComparativePressView
Description	The returns from the press 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	usePlenaryPressView
Description	A complete view of the `Presses` 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	getRootPressIds
Description	Gets the root press `Ids` in this hierarchy.
Return	`osid.id.IdList`		the root press `Ids`
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getRootPresses
Description	Gets the root press in the press hierarchy. an press with no parents is an orphan. While all press `Ids` are known to the hierarchy, an orphan does not appear in the hierarchy unless explicitly added as a root press or child of another press.
Return	`osid.lexicon.PressList`		the root presses
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method is must be implemented.
Method	hasParentPresses
Description	Tests if the `Press` has any parents.
Parameters	`osid.id.Id`	`pressId`	an press `Id`
Return	`boolean`		`true` if the press has parents, f `alse` otherwise
Errors	NOT_FOUND		`pressId` is not found
	NULL_ARGUMENT		`pressId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	isParentOfPress
Description	Tests if an `Id` is a direct parent of press.
Parameters	`osid.id.Id`	`id`	an `Id`
Parameters	`osid.id.Id`	`pressId`	the `Id` of an press
Return	`boolean`		`true` if this `id` is a parent of `pressId`, f `alse` otherwise
Errors	NOT_FOUND		`pressId` is not found
	NULL_ARGUMENT		`id` or `pressId` 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	getParentPressIds
Description	Gets the parent `Ids` of the given press.
Parameters	`osid.id.Id`	`pressId`	an press `Id`
Return	`osid.id.IdList`		the parent `Ids` of the press
Errors	NOT_FOUND		`pressId` is not found
	NULL_ARGUMENT		`pressId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getParentPresses
Description	Gets the parents of the given press.
Parameters	`osid.id.Id`	`pressId`	the `Id` to query
Return	`osid.lexicon.PressList`		the parents of the press
Errors	NOT_FOUND		`pressId` not found
	NULL_ARGUMENT		`pressId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	isAncestorOfPress
Description	Tests if an `Id` is an ancestor of an press.
Parameters	`osid.id.Id`	`id`	an `Id`
Parameters	`osid.id.Id`	`pressId`	the `Id` of an press
Return	`boolean`		`true` if this `id` is an ancestor of `pressId`, `false` otherwise
Errors	NOT_FOUND		`pressId` not found
	NULL_ARGUMENT		`pressId` 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	hasChildPresses
Description	Tests if an press has any children.
Parameters	`osid.id.Id`	`pressId`	an press `Id`
Return	`boolean`		`true` if the `pressId` has children, `false` otherwise
Errors	NOT_FOUND		`pressId` not found
	NULL_ARGUMENT		`pressId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	isChildOfPress
Description	Tests if an press is a direct child of another.
Parameters	`osid.id.Id`	`id`	an `Id`
Parameters	`osid.id.Id`	`pressId`	the `Id` of an press
Return	`boolean`		`true` if the `id` is a child of `pressId`, `false` otherwise
Errors	NOT_FOUND		`pressId` not found
	NULL_ARGUMENT		`id` or `pressId` 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	getChildPressIds
Description	Gets the child `Ids` of the given press.
Parameters	`osid.id.Id`	`pressId`	the `Id` to query
Return	`osid.id.IdList`		the children of the press
Errors	NOT_FOUND		`pressId` not found
	NULL_ARGUMENT		`pressId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getChildPresses
Description	Gets the children of the given press.
Parameters	`osid.id.Id`	`pressId`	the `Id` to query
Return	`osid.lexicon.PressList`		the children of the press
Errors	NOT_FOUND		`pressId` not found
	NULL_ARGUMENT		`pressId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	isDescendantOfPress
Description	Tests if an `Id` is a descendant of an press.
Parameters	`osid.id.Id`	`id`	an `Id`
Parameters	`osid.id.Id`	`pressId`	the `Id` of an press
Return	`boolean`		`true` if the `id` is a descendant of the `pressId`, `false` otherwise
Errors	NOT_FOUND		`pressId` not found
	NULL_ARGUMENT		`id` or `pressId` 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	getPressNodeIds
Description	Gets a portion of the hierarchy for the given press.
Parameters	`osid.id.Id`	`pressId`	the `Id` to query
	`cardinal`	`ancestorLevels`	the maximum number of ancestor levels to include. A value of 0 returns no parents in the press.
	`cardinal`	`descendantLevels`	the maximum number of descendant levels to include. A value of 0 returns no children in the press.
	`boolean`	`includeSiblings`	`true` to include the siblings of the given press, `false` to omit the siblings
Return	`osid.hierarchy.Node`		an press node
Errors	NOT_FOUND		`pressId` not found
	NULL_ARGUMENT		`pressId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getPressNodes
Description	Gets a portion of the hierarchy for the given press.
Parameters	`osid.id.Id`	`pressId`	the `Id` to query
	`cardinal`	`ancestorLevels`	the maximum number of ancestor levels to include. A value of 0 returns no parents in the hierarchy.
	`cardinal`	`descendantLevels`	the maximum number of descendant levels to include. A value of 0 returns no children in the hierarchy.
	`boolean`	`includeSiblings`	`true` to include the siblings of the given press, `false` to omit the siblings
Return	`osid.lexicon.PressNode`		an press node
Errors	NOT_FOUND		`pressId` not found
	NULL_ARGUMENT		`pressId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.