OSID - osid.transport.EndpointHierarchySession Service Interface Definition

Interface	osid.transport.EndpointHierarchySession
Implements	`osid.OsidSession`
Used By	`osid.transport.TransportManager`
Used By	`osid.transport.TransportProxyManager`
Description	This session defines methods for traversing a hierarchy of `Endpoint` objects. Each node in the hierarchy is a unique `Endpoint`. The hierarchy may be traversed recursively to establish the tree structure through `getParentEndpoints()` and `getChildEndpoints()`. To relate these `Ids` to another OSID, `getEndpointNodes()` can be used for retrievals that can be used for bulk lookups in other OSIDs. Any `Endpoint` available in the Resource 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 `getParentEndpoints()` or `getChildEndpoints()` 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: endpoint elements may be silently omitted or re-ordered plenary view: provides a complete set or is an error condition
Method	getEndpointHierarchyId
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	getEndpointHierarchy
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	canAccessEndpointHierarchy
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 not offer traversal functions to unauthorized users.
Return	`boolean`		`false` if hierarchy traversal methods are not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	useComparativeEndpointView
Description	The returns from the endpoint 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	usePlenaryEndpointView
Description	A complete view of the `Endpoint` 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	getRootEndpointIds
Description	Gets the root endpoint `Ids` in this hierarchy.
Return	`osid.id.IdList`		the root endpoint `Ids`
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getRootEndpoints
Description	Gets the root endpoints in the endpoint hierarchy. A node with no parents is an orphan. While all endpoint `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.transport.EndpointList`		the root endpoints
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method is must be implemented.
Method	hasParentEndpoints
Description	Tests if the `Endpoint` has any parents.
Parameters	`osid.id.Id`	`endpointId`	the `Id` of a endpoint
Return	`boolean`		`true` if the endpoint has parents, `false` otherwise
Errors	NOT_FOUND		`endpointId` is not found
	NULL_ARGUMENT		`endpointId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	isParentOfEndpoint
Description	Tests if an `Id` is a direct parent of a endpoint.
Parameters	`osid.id.Id`	`id`	an `Id`
Parameters	`osid.id.Id`	`endpointId`	the `Id` of a endpoint
Return	`boolean`		`true` if this `id` is a parent of `endpointId`, `false` otherwise
Errors	NOT_FOUND		`endpointId` is not found
	NULL_ARGUMENT		`id` or `endpointId` 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	getParentEndpointIds
Description	Gets the parent `Ids` of the given endpoint.
Parameters	`osid.id.Id`	`endpointId`	the `Id` of a endpoint
Return	`osid.id.IdList`		the parent `Ids` of the endpoint
Errors	NOT_FOUND		`endpointId` is not found
	NULL_ARGUMENT		`endpointId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getParentEndpoints
Description	Gets the parents of the given endpoint.
Parameters	`osid.id.Id`	`endpointId`	the `Id` to query
Return	`osid.transport.EndpointList`		the parents of the endpoint
Errors	NOT_FOUND		`endpointId` not found
	NULL_ARGUMENT		`endpointId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	isAncestorOfEndpoint
Description	Tests if an `Id` is an ancestor of a endpoint.
Parameters	`osid.id.Id`	`id`	an `Id`
Parameters	`osid.id.Id`	`endpointId`	the `Id` of a endpoint
Return	`boolean`		`true` if this `id` is an ancestor of `endpointId`, `false` otherwise
Errors	NOT_FOUND		`endpointId` is not found
	NULL_ARGUMENT		`id` or `endpointId` 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	hasChildEndpoints
Description	Tests if a endpoint has any children.
Parameters	`osid.id.Id`	`endpointId`	the `Id` of a endpoint
Return	`boolean`		`true` if the `endpointId` has children, `false` otherwise
Errors	NOT_FOUND		`endpointId` not found
	NULL_ARGUMENT		`endpointId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	isChildOfEndpoint
Description	Tests if a endpoint is a direct child of another.
Parameters	`osid.id.Id`	`id`	an `Id`
Parameters	`osid.id.Id`	`endpointId`	the `Id` of a endpoint
Return	`boolean`		`true` if the `id` is a child of `endpointId`, `false` otherwise
Errors	NOT_FOUND		`endpointId` is not found
	NULL_ARGUMENT		`id` or `endpointId` 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	getChildEndpointIds
Description	Gets the child `Ids` of the given endpoint.
Parameters	`osid.id.Id`	`endpointId`	the `Id` to query
Return	`osid.id.IdList`		the children of the endpoint
Errors	NOT_FOUND		`endpointId` not found
	NULL_ARGUMENT		`endpointId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getChildEndpoints
Description	Gets the children of the given endpoint.
Parameters	`osid.id.Id`	`endpointId`	the `Id` to query
Return	`osid.transport.EndpointList`		the children of the endpoint
Errors	NOT_FOUND		`endpointId` not found
	NULL_ARGUMENT		`endpointId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	isDescendantOfEndpoint
Description	Tests if an `Id` is a descendant of a endpoint.
Parameters	`osid.id.Id`	`id`	an `Id`
Parameters	`osid.id.Id`	`endpointId`	the `Id` of a endpoint
Return	`boolean`		`true` if the `id` is a descendant of the `endpointId`, `false` otherwise
Errors	NOT_FOUND		`endpointId` is not found
	NULL_ARGUMENT		`id` or `endpointId` 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	getEndpointNodeIds
Description	Gets a portion of the hierarchy for the given endpoint.
Parameters	`osid.id.Id`	`endpointId`	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 endpoint node
Errors	NOT_FOUND		`endpointId` not found
	NULL_ARGUMENT		`endpointId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getEndpointNodes
Description	Gets a portion of the hierarchy for the given endpoint.
Parameters	`osid.id.Id`	`endpointId`	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.transport.EndpointNode`		a endpoint node
Errors	NOT_FOUND		`endpointId` not found
	NULL_ARGUMENT		`endpointId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.