OSID - osid.mapping.MapHierarchySession Service Interface Definition

Interface	osid.mapping.MapHierarchySession
Implements	`osid.OsidSession`
Description	This session defines methods for traversing a hierarchy of `Map` objects. Each node in the hierarchy is a unique `Map.` The hierarchy may be traversed recursively to establish the tree structure through `getParentMaps()` and `getChildMaps().` To relate these `Ids` to another OSID, `getMapNodes()` can be used for retrievals that can be used for bulk lookups in other OSIDs. Any `Map` available in the Mapping OSID is known to this hierarchy but does not appear in the hierarchy traversal until added as a root location or a child of another location. 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 `getParentMaps()` or `getChildMaps()` 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 map view: map elements may be silently omitted or re-ordered plenary map view: provides a complete set or is an error condition
Method	getMapHierarchyId
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	getMapHierarchy
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	canAccessMapHierarchy
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	useComparativeMapView
Description	The returns from the map 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	usePlenaryMapView
Description	A complete view of the `Maps` 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	getRootMapIds
Description	Gets the root map `Ids` in this hierarchy.
Return	`osid.id.IdList`		the root map `Ids`
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getRootMaps
Description	Gets the root map in the map hierarchy. A location with no parents is an orphan. While all map `Ids` are known to the hierarchy, an orphan does not appear in the hierarchy unless explicitly added as a root location or child of another location.
Return	`osid.mapping.MapList`		the root maps
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method is must be implemented.
Method	hasParentMaps
Description	Tests if the `Map` has any parents.
Parameters	`osid.id.Id`	`mapId`	a map `Id`
Return	`boolean`		`true` if the map has parents, f `alse` otherwise
Errors	NOT_FOUND		`mapId` is not found
	NULL_ARGUMENT		`mapId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	isParentOfMap
Description	Tests if an `Id` is a direct parent of map.
Parameters	`osid.id.Id`	`id`	an `Id`
Parameters	`osid.id.Id`	`mapId`	the `Id` of a map
Return	`boolean`		`true` if this `id` is a parent of `mapId,` f `alse` otherwise
Errors	NOT_FOUND		`mapId` is not found
	NULL_ARGUMENT		`id` or `mapId` 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	getParentMapIds
Description	Gets the parent `Ids` of the given map.
Parameters	`osid.id.Id`	`mapId`	a map `Id`
Return	`osid.id.IdList`		the parent `Ids` of the map
Errors	NOT_FOUND		`mapId` is not found
	NULL_ARGUMENT		`mapId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getParentMaps
Description	Gets the parents of the given map.
Parameters	`osid.id.Id`	`mapId`	the `Id` to query
Return	`osid.mapping.MapList`		the parents of the map
Errors	NOT_FOUND		`mapId` not found
	NULL_ARGUMENT		`mapId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	isAncestorOfMap
Description	Tests if an `Id` is an ancestor of a map.
Parameters	`osid.id.Id`	`id`	an `Id`
Parameters	`osid.id.Id`	`mapId`	the `Id` of a map
Return	`boolean`		`tru` e if this `id` is an ancestor of `mapId,` `false` otherwise
Errors	NOT_FOUND		`mapId` not found
	NULL_ARGUMENT		`mapId` 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	hasChildMaps
Description	Tests if a map has any children.
Parameters	`osid.id.Id`	`mapId`	a map `Id`
Return	`boolean`		`true` if the `mapId` has children, `false` otherwise
Errors	NOT_FOUND		`mapId` not found
	NULL_ARGUMENT		`mapId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	isChildOfMap
Description	Tests if a map is a direct child of another.
Parameters	`osid.id.Id`	`id`	an `Id`
Parameters	`osid.id.Id`	`mapId`	the `Id` of a map
Return	`boolean`		`true` if the `id` is a child of `mapId,` `false` otherwise
Errors	NOT_FOUND		`mapId` not found
	NULL_ARGUMENT		`id` or `mapId` 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	getChildMapIds
Description	Gets the child `Ids` of the given map.
Parameters	`osid.id.Id`	`mapId`	the `Id` to query
Return	`osid.id.IdList`		the children of the map
Errors	NOT_FOUND		`mapId` not found
	NULL_ARGUMENT		`mapId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getChildMaps
Description	Gets the children of the given map.
Parameters	`osid.id.Id`	`mapId`	the `Id` to query
Return	`osid.mapping.MapList`		the children of the map
Errors	NOT_FOUND		`mapId` not found
	NULL_ARGUMENT		`mapId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	isDescendantOfMap
Description	Tests if an `Id` is a descendant of a map.
Parameters	`osid.id.Id`	`id`	an `Id`
Parameters	`osid.id.Id`	`mapId`	the `Id` of a map
Return	`boolean`		`true` if the `id` is a descendant of the `mapId,` `false` otherwise
Errors	NOT_FOUND		`mapId` not found
	NULL_ARGUMENT		`id` or `mapId` 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	getMapNodeIds
Description	Gets a portion of the hierarchy for the given map.
Parameters	`osid.id.Id`	`mapId`	the `Id` to query
	`cardinal`	`ancestorLevels`	the maximum number of ancestor levels to include. A value of 0 returns no parents in the location.
	`cardinal`	`descendantLevels`	the maximum number of descendant levels to include. A value of 0 returns no children in the location.
	`boolean`	`includeSiblings`	`true` to include the siblings of the given location, `false` to omit the siblings
Return	`osid.hierarchy.Node`		a map node
Errors	NOT_FOUND		`mapId` not found
	NULL_ARGUMENT		`mapId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getMapNodes
Description	Gets a portion of the hierarchy for the given map.
Parameters	`osid.id.Id`	`mapId`	the `Id` to query
	`cardinal`	`ancestorLevels`	the maximum number of ancestor levels to include. A value of 0 returns no parents in the location.
	`cardinal`	`descendantLevels`	the maximum number of descendant levels to include. A value of 0 returns no children in the location.
	`boolean`	`includeSiblings`	`true` to include the siblings of the given location, `false` to omit the siblings
Return	`osid.mapping.MapNode`		a map node
Errors	NOT_FOUND		`mapId` not found
	NULL_ARGUMENT		`mapId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.