Interface EngineHierarchySession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface EngineHierarchySession
extends OsidSession

This session defines methods for traversing a hierarchy of Engines . Each node in the hierarchy is a unique Engine . The hierarchy may be traversed recursively to establish the tree structure through getParentEngines() and getChildEngines() . To relate these Ids to another OSID, getEngienNodes() can be used for retrievals that can be used for bulk lookups in other OSIDs. Any Engine available in the Rule 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 getParentEngines() or getChildEngines() 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: engine 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	canAccessEngineHierarchy()	Tests if this user can perform hierarchy queries.
IdList	getChildEngineIds(Id engineId)	Gets the child Ids of the given engine.
EngineList	getChildEngines(Id engineId)	Gets the child engines of the given id .
Hierarchy	getEngineHierarchy()	Gets the hierarchy associated with this session.
Id	getEngineHierarchyId()	Gets the hierarchy Id associated with this session.
Node	getEngineNodeIds(Id engineId, long ancestorLevels, long descendantLevels, boolean includeSiblings)	Gets a portion of the hierarchy for the given engine.
EngineNode	getEngineNodes(Id engineId, long ancestorLevels, long descendantLevels, boolean includeSiblings)	Gets a portion of the hierarchy for the given engine.
IdList	getParentEngineIds(Id engineId)	Gets the parent Ids of the given engine
EngineList	getParentEngines(Id engineId)	Gets the parent engines of the given id .
IdList	getRootEngineIds()	Gets the root engine Ids in this hierarchy.
EngineList	getRootEngines()	Gets the root engines in this engine hierarchy.
boolean	hasChildEngines(Id engineId)	Tests if an engine has any children.
boolean	hasParentEngines(Id engineId)	Tests if the Engine has any parents.
boolean	isAncestorOfEngine(Id id, Id engineId)	Tests if an Id is an ancestor of an engine.
boolean	isChildOfEngine(Id id, Id engineId)	Tests if an engine is a direct child of another.
boolean	isDescendantOfEngine(Id id, Id engineId)	Tests if an Id is a descendant of an egine.
boolean	isParentOfEngine(Id id, Id engineId)	Tests if an Id is a direct parent of an engine.
void	useComparativeEngineView()	The returns from the engine methods may omit or translate elements based on this session, such as authorization, and not result in an error.
void	usePlenaryEngineView()	A complete view of the Engine 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

getEngineHierarchyId

Id getEngineHierarchyId()

Gets the hierarchy Id associated with this session.

Returns:

the hierarchy Id associated with this session

Compliance:

mandatory - This method must be implemented.

getEngineHierarchy

Hierarchy getEngineHierarchy()
                      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.

canAccessEngineHierarchy

boolean canAccessEngineHierarchy()

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 wish not to offer traversal operations to unauthorized users.

Returns:

false if hierarchy traversal methods are not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

useComparativeEngineView

void useComparativeEngineView()

The returns from the engine 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.

usePlenaryEngineView

void usePlenaryEngineView()

A complete view of the Engine 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.

getRootEngineIds

IdList getRootEngineIds()
                 throws OperationFailedException,
PermissionDeniedException

Gets the root engine Ids in this hierarchy.

Returns:

the root engine Ids

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getRootEngines

EngineList getRootEngines()
                   throws OperationFailedException,
PermissionDeniedException

Gets the root engines in this engine hierarchy.

Returns:

the root engines

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method is must be implemented.

hasParentEngines

boolean hasParentEngines(Id engineId)
                  throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if the Engine has any parents.

Parameters:

engineId - the Id of an engine

Returns:

true if the engine has parents, false otherwise

Throws:

NotFoundException - engineId is not found

NullArgumentException - engineId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

isParentOfEngine

boolean isParentOfEngine(Id id,
 Id engineId)
                  throws NotFoundException,
OperationFailedException,
PermissionDeniedException

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

Parameters:

id - an Id

engineId - the Id of an egine

Returns:

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

Throws:

NotFoundException - engineId is not found

NullArgumentException - id or engineId 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} .

getParentEngineIds

IdList getParentEngineIds(Id engineId)
                   throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the parent Ids of the given engine

Parameters:

engineId - the Id of an egine

Returns:

the parent Ids of the engine

Throws:

NotFoundException - engineId is not found

NullArgumentException - engineId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getParentEngines

EngineList getParentEngines(Id engineId)
                     throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the parent engines of the given id .

Parameters:

engineId - the Id of the Engine to query

Returns:

the parent engines of the id

Throws:

NotFoundException - an Engine identified by Id is not found

NullArgumentException - engineId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

isAncestorOfEngine

boolean isAncestorOfEngine(Id id,
 Id engineId)
                    throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if an Id is an ancestor of an engine.

Parameters:

id - an Id

engineId - the Id of an engine

Returns:

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

Throws:

NotFoundException - engineId is not found

NullArgumentException - id or engineId 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} .

hasChildEngines

boolean hasChildEngines(Id engineId)
                 throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if an engine has any children.

Parameters:

engineId - the Id of an engine

Returns:

true if the engineId has children, false otherwise

Throws:

NotFoundException - engineId is not found

NullArgumentException - engineId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

isChildOfEngine

boolean isChildOfEngine(Id id,
 Id engineId)
                 throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if an engine is a direct child of another.

Parameters:

id - an Id

engineId - the Id of an engine

Returns:

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

Throws:

NotFoundException - engineId is not found

NullArgumentException - id or engineId 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} .

getChildEngineIds

IdList getChildEngineIds(Id engineId)
                  throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the child Ids of the given engine.

Parameters:

engineId - the Id to query

Returns:

the children of the engine

Throws:

NotFoundException - engineId is not found

NullArgumentException - engineId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getChildEngines

EngineList getChildEngines(Id engineId)
                    throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the child engines of the given id .

Parameters:

engineId - the Id of the Engine to query

Returns:

the child engines of the id

Throws:

NotFoundException - an Engine identified by Id is not found

NullArgumentException - engineId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

isDescendantOfEngine

boolean isDescendantOfEngine(Id id,
 Id engineId)
                      throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if an Id is a descendant of an egine.

Parameters:

id - an Id

engineId - the Id of an engine

Returns:

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

Throws:

NotFoundException - engineId is not found

NullArgumentException - id or engineId 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} .

getEngineNodeIds

Node getEngineNodeIds(Id engineId,
 long ancestorLevels,
 long descendantLevels,
 boolean includeSiblings)
               throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets a portion of the hierarchy for the given engine.

Parameters:

engineId - 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:

an engine node

Throws:

NotFoundException - engineId is not found

NullArgumentException - engineId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getEngineNodes

EngineNode getEngineNodes(Id engineId,
 long ancestorLevels,
 long descendantLevels,
 boolean includeSiblings)
                   throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets a portion of the hierarchy for the given engine.

Parameters:

engineId - 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:

an engine node

Throws:

NotFoundException - engineId is not found

NullArgumentException - engineId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.