Interface SystemHierarchySession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface SystemHierarchySession
extends OsidSession

This session defines methods for traversing a hierarchy of Systems . Each node in the hierarchy is a unique System . The hierarchy may be traversed recursively to establish the tree structure through getParentSystems() and getChildSystems() . To relate these Ids to another OSID, getSystemNodes() can be used for retrievals that can be used for bulk lookups in other OSIDs. Any System available in the Control OSID is known to this hierarchy but does not appear in the hierarchy traversal until added as a root system or a child of another system.

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 getParentSystems() or getChildSystems() in lieu of a PERMISSION_DENIED error that may disrupt the traversal through authorized deviceways.

This session defines views that offer differing behaviors when retrieving multiple objects.

• comparative system view: system elements may be silently omitted or re-ordered
• plenary system view: provides a complete set or is an error condition

Method Summary

Modifier and Type	Method	Description
boolean	canAccessSystemHierarchy()	Tests if this user can perform hierarchy queries.
IdList	getChildSystemIds(Id systemId)	Gets the child Ids of the given system.
SystemList	getChildSystems(Id systemId)	Gets the children of the given system.
IdList	getParentSystemIds(Id systemId)	Gets the parent Ids of the given system.
SystemList	getParentSystems(Id systemId)	Gets the parents of the given system.
IdList	getRootSystemIds()	Gets the root system Ids in this hierarchy.
SystemList	getRootSystems()	Gets the root system in the system hierarchy.
Hierarchy	getSystemHierarchy()	Gets the hierarchy associated with this session.
Id	getSystemHierarchyId()	Gets the hierarchy Id associated with this session.
Node	getSystemNodeIds(Id systemId, long ancestorLevels, long descendantLevels, boolean includeSiblings)	Gets a portion of the hierarchy for the given system.
SystemNode	getSystemNodes(Id systemId, long ancestorLevels, long descendantLevels, boolean includeSiblings)	Gets a portion of the hierarchy for the given system.
boolean	hasChildSystems(Id systemId)	Tests if a system has any children.
boolean	hasParentSystems(Id systemId)	Tests if the System has any parents.
boolean	isAncestorOfSystem(Id id, Id systemId)	Tests if an Id is an ancestor of a system.
boolean	isChildOfSystem(Id id, Id systemId)	Tests if a system is a direct child of another.
boolean	isDescendantOfSystem(Id id, Id systemId)	Tests if an Id is a descendant of a system.
boolean	isParentOfSystem(Id id, Id systemId)	Tests if an Id is a direct parent of system.
void	useComparativeSystemView()	The returns from the system methods may omit or translate elements based on this session, such as authorization, and not result in an error.
void	usePlenarySystemView()	A complete view of the Systems 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

getSystemHierarchyId

Id getSystemHierarchyId()

Gets the hierarchy Id associated with this session.

Returns:

the hierarchy Id associated with this session

Compliance:

mandatory - This method must be implemented.

getSystemHierarchy

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

canAccessSystemHierarchy

boolean canAccessSystemHierarchy()

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.

Returns:

false if hierarchy traversal methods are not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

useComparativeSystemView

void useComparativeSystemView()

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

usePlenarySystemView

void usePlenarySystemView()

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

getRootSystemIds

IdList getRootSystemIds()
                 throws OperationFailedException,
PermissionDeniedException

Gets the root system Ids in this hierarchy.

Returns:

the root system Ids

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getRootSystems

SystemList getRootSystems()
                   throws OperationFailedException,
PermissionDeniedException

Gets the root system in the system hierarchy. A system with no parents is an orphan. While all system Ids are known to the hierarchy, an orphan does not appear in the hierarchy unless explicitly added as a root system or child of another system.

Returns:

the root systems

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method is must be implemented.

hasParentSystems

boolean hasParentSystems(Id systemId)
                  throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if the System has any parents.

Parameters:

systemId - a system Id

Returns:

true if the system has parents, f alse otherwise

Throws:

NotFoundException - systemId is not found

NullArgumentException - systemId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

isParentOfSystem

boolean isParentOfSystem(Id id,
 Id systemId)
                  throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if an Id is a direct parent of system.

Parameters:

id - an Id

systemId - the Id of a system

Returns:

true if this id is a parent of systemId , f alse otherwise

Throws:

NotFoundException - systemId is not found

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

getParentSystemIds

IdList getParentSystemIds(Id systemId)
                   throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the parent Ids of the given system.

Parameters:

systemId - a system Id

Returns:

the parent Ids of the system

Throws:

NotFoundException - systemId is not found

NullArgumentException - systemId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getParentSystems

SystemList getParentSystems(Id systemId)
                     throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the parents of the given system.

Parameters:

systemId - the Id to query

Returns:

the parents of the system

Throws:

NotFoundException - systemId not found

NullArgumentException - systemId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

isAncestorOfSystem

boolean isAncestorOfSystem(Id id,
 Id systemId)
                    throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if an Id is an ancestor of a system.

Parameters:

id - an Id

systemId - the Id of a system

Returns:

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

Throws:

NotFoundException - systemId not found

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

hasChildSystems

boolean hasChildSystems(Id systemId)
                 throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if a system has any children.

Parameters:

systemId - a system Id

Returns:

true if the systemId has children, false otherwise

Throws:

NotFoundException - systemId not found

NullArgumentException - systemId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

isChildOfSystem

boolean isChildOfSystem(Id id,
 Id systemId)
                 throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if a system is a direct child of another.

Parameters:

id - an Id

systemId - the Id of a system

Returns:

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

Throws:

NotFoundException - systemId not found

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

getChildSystemIds

IdList getChildSystemIds(Id systemId)
                  throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the child Ids of the given system.

Parameters:

systemId - the Id to query

Returns:

the children of the system

Throws:

NotFoundException - systemId not found

NullArgumentException - systemId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getChildSystems

SystemList getChildSystems(Id systemId)
                    throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the children of the given system.

Parameters:

systemId - the Id to query

Returns:

the children of the system

Throws:

NotFoundException - systemId not found

NullArgumentException - systemId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

isDescendantOfSystem

boolean isDescendantOfSystem(Id id,
 Id systemId)
                      throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if an Id is a descendant of a system.

Parameters:

id - an Id

systemId - the Id of a system

Returns:

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

Throws:

NotFoundException - systemId not found

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

getSystemNodeIds

Node getSystemNodeIds(Id systemId,
 long ancestorLevels,
 long descendantLevels,
 boolean includeSiblings)
               throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets a portion of the hierarchy for the given system.

Parameters:

systemId - the Id to query

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

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

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

Returns:

a system node

Throws:

NotFoundException - systemId not found

NullArgumentException - systemId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getSystemNodes

SystemNode getSystemNodes(Id systemId,
 long ancestorLevels,
 long descendantLevels,
 boolean includeSiblings)
                   throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets a portion of the hierarchy for the given system.

Parameters:

systemId - the Id to query

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

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

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

Returns:

a system node

Throws:

NotFoundException - systemId not found

NullArgumentException - systemId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.