OSID - osid.sequencing.AntimatroidHierarchySession Service Interface Definition

Interface	osid.sequencing.AntimatroidHierarchySession
Implements	`osid.OsidSession`
Description	This session defines methods for traversing a hierarchy of `Antimatroid` objects. Each node in the hierarchy is a unique `Antimatroid.` The hierarchy may be traversed recursively to establish the tree structure through `getParentAntimatroids()` and `getChildAntimatroids().` To relate these `Ids` to another OSID, `getAntimatroidNodes()` can be used for retrievals that can be used for bulk lookups in other OSIDs. Any `Antimatroid` available in the Sequencing OSID is known to this hierarchy but does not appear in the hierarchy traversal until added as a root antimatroid or a child of another antimatroid. 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 `getParentAntimatroids()` or `getChildAntimatroids()` in lieu of a `PERMISSION_DENIED` error that may disrupt the traversal through authorized featureways. This session defines views that offer differing behaviors when retrieving multiple objects. comparative antimatroid view: antimatroid elements may be silently omitted or re-ordered plenary antimatroid view: provides a complete set or is an error condition
Method	getAntimatroidHierarchyId
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	getAntimatroidHierarchy
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	canAccessAntimatroidHierarchy
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	useComparativeAntimatroidView
Description	The returns from the antimatroid 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	usePlenaryAntimatroidView
Description	A complete view of the `Antimatroids` 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	getRootAntimatroidIds
Description	Gets the root antimatroid `Ids` in this hierarchy.
Return	`osid.id.IdList`		the root antimatroid `Ids`
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getRootAntimatroids
Description	Gets the root antimatroid in the antimatroid hierarchy. an antimatroid with no parents is an orphan. While all antimatroid `Ids` are known to the hierarchy, an orphan does not appear in the hierarchy unless explicitly added as a root antimatroid or child of another antimatroid.
Return	`osid.sequencing.AntimatroidList`		the root antimatroids
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method is must be implemented.
Method	hasParentAntimatroids
Description	Tests if the `Antimatroid` has any parents.
Parameters	`osid.id.Id`	`antimatroidId`	an antimatroid `Id`
Return	`boolean`		`true` if the antimatroid has parents, f `alse` otherwise
Errors	NOT_FOUND		`antimatroidId` is not found
	NULL_ARGUMENT		`antimatroidId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	isParentOfAntimatroid
Description	Tests if an `Id` is a direct parent of antimatroid.
Parameters	`osid.id.Id`	`id`	an `Id`
Parameters	`osid.id.Id`	`antimatroidId`	the `Id` of an antimatroid
Return	`boolean`		`true` if this `id` is a parent of `antimatroidId,` f `alse` otherwise
Errors	NOT_FOUND		`antimatroidId` is not found
	NULL_ARGUMENT		`id` or `antimatroidId` 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	getParentAntimatroidIds
Description	Gets the parent `Ids` of the given antimatroid.
Parameters	`osid.id.Id`	`antimatroidId`	an antimatroid `Id`
Return	`osid.id.IdList`		the parent `Ids` of the antimatroid
Errors	NOT_FOUND		`antimatroidId` is not found
	NULL_ARGUMENT		`antimatroidId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getParentAntimatroids
Description	Gets the parents of the given antimatroid.
Parameters	`osid.id.Id`	`antimatroidId`	the `Id` to query
Return	`osid.sequencing.AntimatroidList`		the parents of the antimatroid
Errors	NOT_FOUND		`antimatroidId` not found
	NULL_ARGUMENT		`antimatroidId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	isAncestorOfAntimatroid
Description	Tests if an `Id` is an ancestor of an antimatroid.
Parameters	`osid.id.Id`	`id`	an `Id`
Parameters	`osid.id.Id`	`antimatroidId`	the `Id` of an antimatroid
Return	`boolean`		`tru` e if this `id` is an ancestor of `antimatroidId,` `false` otherwise
Errors	NOT_FOUND		`antimatroidId` not found
	NULL_ARGUMENT		`antimatroidId` 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	hasChildAntimatroids
Description	Tests if an antimatroid has any children.
Parameters	`osid.id.Id`	`antimatroidId`	an antimatroid `Id`
Return	`boolean`		`true` if the `antimatroidId` has children, `false` otherwise
Errors	NOT_FOUND		`antimatroidId` not found
	NULL_ARGUMENT		`antimatroidId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	isChildOfAntimatroid
Description	Tests if an antimatroid is a direct child of another.
Parameters	`osid.id.Id`	`id`	an `Id`
Parameters	`osid.id.Id`	`antimatroidId`	the `Id` of an antimatroid
Return	`boolean`		`true` if the `id` is a child of `antimatroidId,` `false` otherwise
Errors	NOT_FOUND		`antimatroidId` not found
	NULL_ARGUMENT		`id` or `antimatroidId` 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	getChildAntimatroidIds
Description	Gets the child `Ids` of the given antimatroid.
Parameters	`osid.id.Id`	`antimatroidId`	the `Id` to query
Return	`osid.id.IdList`		the children of the antimatroid
Errors	NOT_FOUND		`antimatroidId` not found
	NULL_ARGUMENT		`antimatroidId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getChildAntimatroids
Description	Gets the children of the given antimatroid.
Parameters	`osid.id.Id`	`antimatroidId`	the `Id` to query
Return	`osid.sequencing.AntimatroidList`		the children of the antimatroid
Errors	NOT_FOUND		`antimatroidId` not found
	NULL_ARGUMENT		`antimatroidId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	isDescendantOfAntimatroid
Description	Tests if an `Id` is a descendant of an antimatroid.
Parameters	`osid.id.Id`	`id`	an `Id`
Parameters	`osid.id.Id`	`antimatroidId`	the `Id` of an antimatroid
Return	`boolean`		`true` if the `id` is a descendant of the `antimatroidId,` `false` otherwise
Errors	NOT_FOUND		`antimatroidId` not found
	NULL_ARGUMENT		`id` or `antimatroidId` 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	getAntimatroidNodeIds
Description	Gets a portion of the hierarchy for the given antimatroid.
Parameters	`osid.id.Id`	`antimatroidId`	the `Id` to query
	`cardinal`	`ancestorLevels`	the maximum number of ancestor levels to include. A value of 0 returns no parents in the antimatroid.
	`cardinal`	`descendantLevels`	the maximum number of descendant levels to include. A value of 0 returns no children in the antimatroid.
	`boolean`	`includeSiblings`	`true` to include the siblings of the given antimatroid, `false` to omit the siblings
Return	`osid.hierarchy.Node`		an antimatroid node
Errors	NOT_FOUND		`antimatroidId` not found
	NULL_ARGUMENT		`antimatroidId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getAntimatroidNodes
Description	Gets a portion of the hierarchy for the given antimatroid.
Parameters	`osid.id.Id`	`antimatroidId`	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 antimatroid, `false` to omit the siblings
Return	`osid.sequencing.AntimatroidNode`		an antimatroid node
Errors	NOT_FOUND		`antimatroidId` not found
	NULL_ARGUMENT		`antimatroidId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.