org.osid.configuration

Interface ConfigurationHierarchyDesignSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidSession

public interface ConfigurationHierarchyDesignSession
extends OsidSession

This session defines methods for managing a hierarchy of Configuration objects. Each node in the hierarchy is a unique Configuration.

Method Summary

Methods

Modifier and Type	Method and Description
void	addChildConfiguration(Id configurationId, Id childId) Adds a child to a configuration.
void	addRootConfiguration(Id configurationId) Adds a root configuration.
boolean	canModifyConfigurationHierarchy() Tests if this user can change the hierarchy.
Hierarchy	getConfigurationHierarchy() Gets the hierarchy associated with this session.
Id	getConfigurationHierarchyId() Gets the hierarchy Id associated with this session.
void	removeChildConfiguration(Id configurationId, Id childId) Removes a child from a configuration.
void	removeChildConfigurations(Id configurationId) Removes all children from a configuration.
void	removeRootConfiguration(Id configurationId) Removes a root configuration.

Methods inherited from interface org.osid.OsidSession

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

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

getConfigurationHierarchyId

Id getConfigurationHierarchyId()

Gets the hierarchy Id associated with this session.

Returns:

the hierarchy 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.

canModifyConfigurationHierarchy

boolean canModifyConfigurationHierarchy()

Tests if this user can change the hierarchy. A return of true does not guarantee successful authorization. A return of false indicates that it is known performing any update will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer these operations to an unauthorized user.

Returns:

false if changing this hierarchy is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

addRootConfiguration

void addRootConfiguration(Id configurationId)
                          throws AlreadyExistsException,
                                 NotFoundException,
                                 OperationFailedException,
                                 PermissionDeniedException

Adds a root configuration.

Parameters:

configurationId - the Id of a configuration

Throws:

AlreadyExistsException - configurationId is already in hierarchy

NotFoundException - configurationId not found

NullArgumentException - configurationId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

removeRootConfiguration

void removeRootConfiguration(Id configurationId)
                             throws NotFoundException,
                                    OperationFailedException,
                                    PermissionDeniedException

Removes a root configuration.

Parameters:

configurationId - the Id of a configuration

Throws:

NotFoundException - configurationId not a root

NullArgumentException - configurationId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

addChildConfiguration

void addChildConfiguration(Id configurationId,
                         Id childId)
                           throws AlreadyExistsException,
                                  NotFoundException,
                                  OperationFailedException,
                                  PermissionDeniedException

Adds a child to a configuration.

Parameters:

configurationId - the Id of a configuration

childId - the Id of the new child

Throws:

AlreadyExistsException - configurationId is already a parent of childId

NotFoundException - configurationId or childId not found

NullArgumentException - configurationId or childId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

removeChildConfiguration

void removeChildConfiguration(Id configurationId,
                            Id childId)
                              throws NotFoundException,
                                     OperationFailedException,
                                     PermissionDeniedException

Removes a child from a configuration.

Parameters:

configurationId - the Id of a configuration

childId - the Id of the new child

Throws:

NotFoundException - configurationId not a parent of childId

NullArgumentException - configurationId or childId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

removeChildConfigurations

void removeChildConfigurations(Id configurationId)
                               throws NotFoundException,
                                      OperationFailedException,
                                      PermissionDeniedException

Removes all children from a configuration.

Parameters:

configurationId - the Id of a configuration

Throws:

NotFoundException - configurationId is not in hierarchy

NullArgumentException - configurationId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.