Interface ConfigurationHierarchySession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface ConfigurationHierarchySession
extends OsidSession

This session defines methods for traversing a hierarchy of Configurations . Each node in the hierarchy is a unique Configuration . The hierarchy may be traversed recursively to establish the tree structure through getParentConfigurations() and getChildConfigurations() . To relate these Ids to another OSID, getConfigurationNodes() can be used for retrievals that can be used for bulk lookups in other OSIDs. Any Configuration available in the Configuration 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 getParentConfigurationss() or getChildConfigurations() 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: configuration 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	canAccessConfigurationHierarchy()	Tests if this user can perform hierarchy queries.
IdList	getChildConfigurationIds(Id configurationId)	Gets the child Ids of the given configuration.
ConfigurationList	getChildConfigurations(Id configurationId)	Gets the children of the given configuration.
Hierarchy	getConfigurationHierarchy()	Gets the hierarchy associated with this session.
Id	getConfigurationHierarchyId()	Gets the hierarchy Id associated with this session.
Node	getConfigurationNodeIds(Id configurationId, long ancestorLevels, long descendantLevels, boolean includeSiblings)	Gets a portion of the hierarchy for the given configuration.
ConfigurationNode	getConfigurationNodes(Id configurationId, long ancestorLevels, long descendantLevels, boolean includeSiblings)	Gets a portion of the hierarchy for the given configuration.
IdList	getParentConfigurationIds(Id configurationId)	Gets the parent Ids of the given configuration.
ConfigurationList	getParentConfigurations(Id configurationId)	Gets the parents of the given configuration.
IdList	getRootConfigurationIds()	Gets the root configuration Ids in this hierarchy.
ConfigurationList	getRootConfigurations()	Gets the root configurations in the configuration hierarchy.
boolean	hasChildConfigurations(Id configurationId)	Tests if a configuration has any children.
boolean	hasParentConfigurations(Id configurationId)	Tests if the Configuration has any parents.
boolean	isAncestorOfConfiguration(Id id, Id configurationId)	Tests if an Id is an ancestor of a configuration.
boolean	isChildOfConfiguration(Id id, Id configurationId)	Tests if a node is a direct child of another.
boolean	isDescendantOfConfiguration(Id id, Id configurationId)	Tests if an Id is a descendant of a configuration.
boolean	isParentOfConfiguration(Id id, Id configurationId)	Tests if an Id is a direct parent of configuration.
void	useComparativeConfigurationView()	The returns from the configuration methods may omit or translate elements based on this session, such as authorization, and not result in an error.
void	usePlenaryConfigurationView()	A complete view of the Configuration 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

getConfigurationHierarchyId

Id getConfigurationHierarchyId()

Gets the hierarchy Id associated with this session.

Returns:

the configuration Id associated with this session

Compliance:

mandatory - This method must be implemented.

getConfigurationHierarchy

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

canAccessConfigurationHierarchy

boolean canAccessConfigurationHierarchy()

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.

useComparativeConfigurationView

void useComparativeConfigurationView()

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

usePlenaryConfigurationView

void usePlenaryConfigurationView()

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

getRootConfigurationIds

IdList getRootConfigurationIds()
                        throws OperationFailedException,
PermissionDeniedException

Gets the root configuration Ids in this hierarchy.

Returns:

the root configuration Ids

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getRootConfigurations

ConfigurationList getRootConfigurations()
                                 throws OperationFailedException,
PermissionDeniedException

Gets the root configurations in the configuration hierarchy. A node with no parents is an orphan. While all configuration 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 configurations

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method is must be implemented.

hasParentConfigurations

boolean hasParentConfigurations(Id configurationId)
                         throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if the Configuration has any parents.

Parameters:

configurationId - a configuration Id

Returns:

true if the configuration has parents, f alse otherwise

Throws:

NotFoundException - configurationId is not found

NullArgumentException - configurationId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

isParentOfConfiguration

boolean isParentOfConfiguration(Id id,
 Id configurationId)
                         throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if an Id is a direct parent of configuration.

Parameters:

id - an Id

configurationId - a configuration Id

Returns:

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

Throws:

NotFoundException - configurationId is not found

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

getParentConfigurationIds

IdList getParentConfigurationIds(Id configurationId)
                          throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the parent Ids of the given configuration.

Parameters:

configurationId - a configuration Id

Returns:

the parent Ids of the configuration

Throws:

NotFoundException - configurationId is not found

NullArgumentException - configurationId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getParentConfigurations

ConfigurationList getParentConfigurations(Id configurationId)
                                   throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the parents of the given configuration.

Parameters:

configurationId - the Id to query

Returns:

the parents of the configuration

Throws:

NotFoundException - configurationId not found

NullArgumentException - configurationId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

isAncestorOfConfiguration

boolean isAncestorOfConfiguration(Id id,
 Id configurationId)
                           throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if an Id is an ancestor of a configuration.

Parameters:

id - an Id

configurationId - the Id of a configuration

Returns:

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

Throws:

NotFoundException - configurationId is not found

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

hasChildConfigurations

boolean hasChildConfigurations(Id configurationId)
                        throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if a configuration has any children.

Parameters:

configurationId - a configurationId

Returns:

true if the configurationId has children, false otherwise

Throws:

NotFoundException - configurationId not found

NullArgumentException - configurationId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

isChildOfConfiguration

boolean isChildOfConfiguration(Id id,
 Id configurationId)
                        throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if a node is a direct child of another.

Parameters:

id - an Id

configurationId - the Id of a configuration

Returns:

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

Throws:

NotFoundException - configurationId not found

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

getChildConfigurationIds

IdList getChildConfigurationIds(Id configurationId)
                         throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the child Ids of the given configuration.

Parameters:

configurationId - the Id to query

Returns:

the children of the configuration

Throws:

NotFoundException - configurationId is not found

NullArgumentException - configurationId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getChildConfigurations

ConfigurationList getChildConfigurations(Id configurationId)
                                  throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the children of the given configuration.

Parameters:

configurationId - the Id to query

Returns:

the children of the configuration

Throws:

NotFoundException - configurationId not found

NullArgumentException - configurationId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

isDescendantOfConfiguration

boolean isDescendantOfConfiguration(Id id,
 Id configurationId)
                             throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if an Id is a descendant of a configuration.

Parameters:

id - an Id

configurationId - the Id of a configuration

Returns:

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

Throws:

NotFoundException - configurationId is not found

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

getConfigurationNodeIds

Node getConfigurationNodeIds(Id configurationId,
 long ancestorLevels,
 long descendantLevels,
 boolean includeSiblings)
                      throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets a portion of the hierarchy for the given configuration.

Parameters:

configurationId - 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 configuration node

Throws:

NotFoundException - configurationId not found

NullArgumentException - configurationId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getConfigurationNodes

ConfigurationNode getConfigurationNodes(Id configurationId,
 long ancestorLevels,
 long descendantLevels,
 boolean includeSiblings)
                                 throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets a portion of the hierarchy for the given configuration.

Parameters:

configurationId - 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 configuration node

Throws:

NotFoundException - configurationId not found

NullArgumentException - configurationId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.