Interface EndpointHierarchySession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface EndpointHierarchySession
extends OsidSession

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 Summary

Modifier and Type	Method	Description
boolean	canAccessEndpointHierarchy()	Tests if this user can perform hierarchy queries.
IdList	getChildEndpointIds(Id endpointId)	Gets the child Ids of the given endpoint.
EndpointList	getChildEndpoints(Id endpointId)	Gets the children of the given endpoint.
Hierarchy	getEndpointHierarchy()	Gets the hierarchy associated with this session.
Id	getEndpointHierarchyId()	Gets the hierarchy Id associated with this session.
Node	getEndpointNodeIds(Id endpointId, long ancestorLevels, long descendantLevels, boolean includeSiblings)	Gets a portion of the hierarchy for the given endpoint.
EndpointNode	getEndpointNodes(Id endpointId, long ancestorLevels, long descendantLevels, boolean includeSiblings)	Gets a portion of the hierarchy for the given endpoint.
IdList	getParentEndpointIds(Id endpointId)	Gets the parent Ids of the given endpoint.
EndpointList	getParentEndpoints(Id endpointId)	Gets the parents of the given endpoint.
IdList	getRootEndpointIds()	Gets the root endpoint Ids in this hierarchy.
EndpointList	getRootEndpoints()	Gets the root endpoints in the endpoint hierarchy.
boolean	hasChildEndpoints(Id endpointId)	Tests if a endpoint has any children.
boolean	hasParentEndpoints(Id endpointId)	Tests if the Endpoint has any parents.
boolean	isAncestorOfEndpoint(Id id, Id endpointId)	Tests if an Id is an ancestor of a endpoint.
boolean	isChildOfEndpoint(Id id, Id endpointId)	Tests if a endpoint is a direct child of another.
boolean	isDescendantOfEndpoint(Id id, Id endpointId)	Tests if an Id is a descendant of a endpoint.
boolean	isParentOfEndpoint(Id id, Id endpointId)	Tests if an Id is a direct parent of a endpoint.
void	useComparativeEndpointView()	The returns from the endpoint methods may omit or translate elements based on this session, such as authorization, and not result in an error.
void	usePlenaryEndpointView()	A complete view of the Endpoint returns is desired.

Methods inherited from interface Closeable

close

Methods inherited from interface OsidSession

close

Modifier and Type	Method	Description
void	close()	Close this session.

Methods inherited from interface OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Modifier and Type	Method	Description
Agent	getAuthenticatedAgent()	Gets the agent authenticated to this session.
Id	getAuthenticatedAgentId()	Gets the Id of the agent authenticated to this session.
BigDecimal	getClockRate()	Gets the rate of the service clock.
Date	getDate()	Gets the service date which may be the current date or the effective date in which this session exists.
Agent	getEffectiveAgent()	Gets the effective agent in use by this session.
Id	getEffectiveAgentId()	Gets the Id of the effective agent in use by this session.
Type	getFormatType()	Gets the DisplayText format Type preference in effect for this session.
Locale	getLocale()	Gets the locale indicating the localization preferences in effect for this session.
boolean	isAuthenticated()	Tests if an agent is authenticated to this session.
Transaction	startTransaction()	Starts a new transaction for this sesson.
boolean	supportsTransactions()	Tests for the availability of transactions.

Method Details

getEndpointHierarchyId

Id getEndpointHierarchyId()

Gets the hierarchy Id associated with this session.

Returns:

the hierarchy Id associated with this session

Compliance:

mandatory - This method must be implemented.

getEndpointHierarchy

Hierarchy getEndpointHierarchy()
                        throws OperationFailedException,
PermissionDeniedException

Gets the hierarchy associated with this session.

Returns:

the hierarchy associated with this session

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canAccessEndpointHierarchy

boolean canAccessEndpointHierarchy()

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.

Returns:

false if hierarchy traversal methods are not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

useComparativeEndpointView

void useComparativeEndpointView()

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.

usePlenaryEndpointView

void usePlenaryEndpointView()

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.

getRootEndpointIds

IdList getRootEndpointIds()
                   throws OperationFailedException,
PermissionDeniedException

Gets the root endpoint Ids in this hierarchy.

Returns:

the root endpoint Ids

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getRootEndpoints

EndpointList getRootEndpoints()
                       throws OperationFailedException,
PermissionDeniedException

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.

Returns:

the root endpoints

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method is must be implemented.

hasParentEndpoints

boolean hasParentEndpoints(Id endpointId)
                    throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if the Endpoint has any parents.

Parameters:

endpointId - the Id of a endpoint

Returns:

true if the endpoint has parents, false otherwise

Throws:

NotFoundException - endpointId is not found

NullArgumentException - endpointId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

isParentOfEndpoint

boolean isParentOfEndpoint(Id id,
 Id endpointId)
                    throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if an Id is a direct parent of a endpoint.

Parameters:

id - an Id

endpointId - the Id of a endpoint

Returns:

true if this id is a parent of endpointId, false otherwise

Throws:

NotFoundException - endpointId is not found

NullArgumentException - id or endpointId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

Notes:

If - {@code id} not found return {@code false}.

getParentEndpointIds

IdList getParentEndpointIds(Id endpointId)
                     throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the parent Ids of the given endpoint.

Parameters:

endpointId - the Id of a endpoint

Returns:

the parent Ids of the endpoint

Throws:

NotFoundException - endpointId is not found

NullArgumentException - endpointId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getParentEndpoints

EndpointList getParentEndpoints(Id endpointId)
                         throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the parents of the given endpoint.

Parameters:

endpointId - the Id to query

Returns:

the parents of the endpoint

Throws:

NotFoundException - endpointId not found

NullArgumentException - endpointId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

isAncestorOfEndpoint

boolean isAncestorOfEndpoint(Id id,
 Id endpointId)
                      throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if an Id is an ancestor of a endpoint.

Parameters:

id - an Id

endpointId - the Id of a endpoint

Returns:

true if this id is an ancestor of endpointId, false otherwise

Throws:

NotFoundException - endpointId is not found

NullArgumentException - id or endpointId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

Notes:

If - {@code id} not found return {@code false}.

hasChildEndpoints

boolean hasChildEndpoints(Id endpointId)
                   throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if a endpoint has any children.

Parameters:

endpointId - the Id of a endpoint

Returns:

true if the endpointId has children, false otherwise

Throws:

NotFoundException - endpointId not found

NullArgumentException - endpointId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

isChildOfEndpoint

boolean isChildOfEndpoint(Id id,
 Id endpointId)
                   throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if a endpoint is a direct child of another.

Parameters:

id - an Id

endpointId - the Id of a endpoint

Returns:

true if the id is a child of endpointId, false otherwise

Throws:

NotFoundException - endpointId is not found

NullArgumentException - id or endpointId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

Notes:

If - {@code id} not found return {@code false}.

getChildEndpointIds

IdList getChildEndpointIds(Id endpointId)
                    throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the child Ids of the given endpoint.

Parameters:

endpointId - the Id to query

Returns:

the children of the endpoint

Throws:

NotFoundException - endpointId not found

NullArgumentException - endpointId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getChildEndpoints

EndpointList getChildEndpoints(Id endpointId)
                        throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the children of the given endpoint.

Parameters:

endpointId - the Id to query

Returns:

the children of the endpoint

Throws:

NotFoundException - endpointId not found

NullArgumentException - endpointId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

isDescendantOfEndpoint

boolean isDescendantOfEndpoint(Id id,
 Id endpointId)
                        throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if an Id is a descendant of a endpoint.

Parameters:

id - an Id

endpointId - the Id of a endpoint

Returns:

true if the id is a descendant of the endpointId, false otherwise

Throws:

NotFoundException - endpointId is not found

NullArgumentException - id or endpointId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

Notes:

If - {@code id} is not found return {@code false}.

getEndpointNodeIds

Node getEndpointNodeIds(Id endpointId,
 long ancestorLevels,
 long descendantLevels,
 boolean includeSiblings)
                 throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets a portion of the hierarchy for the given endpoint.

Parameters:

endpointId - the Id to query

ancestorLevels - the maximum number of ancestor levels to include. A value of 0 returns no parents in the node.

descendantLevels - the maximum number of descendant levels to include. A value of 0 returns no children in the node.

includeSiblings - true to include the siblings of the given node, false to omit the siblings

Returns:

a endpoint node

Throws:

NotFoundException - endpointId not found

NullArgumentException - endpointId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getEndpointNodes

EndpointNode getEndpointNodes(Id endpointId,
 long ancestorLevels,
 long descendantLevels,
 boolean includeSiblings)
                       throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets a portion of the hierarchy for the given endpoint.

Parameters:

endpointId - the Id to query

ancestorLevels - the maximum number of ancestor levels to include. A value of 0 returns no parents in the node.

descendantLevels - the maximum number of descendant levels to include. A value of 0 returns no children in the node.

includeSiblings - true to include the siblings of the given node, false to omit the siblings

Returns:

a endpoint node

Throws:

NotFoundException - endpointId not found

NullArgumentException - endpointId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.