org.osid.control

Interface SystemHierarchyDesignSession

All Superinterfaces:

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

public interface SystemHierarchyDesignSession
extends OsidSession

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

Method Summary

Methods

Modifier and Type	Method and Description
void	addChildSystem(Id systemId, Id childId) Adds a child to a system.
void	addRootSystem(Id systemId) Adds a root system.
boolean	canModifySystemHierarchy() Tests if this user can change the hierarchy.
Hierarchy	getSystemHierarchy() Gets the hierarchy associated with this session.
Id	getSystemHierarchyId() Gets the hierarchy Id associated with this session.
void	removeChildSystem(Id systemId, Id childId) Removes a child from a system.
void	removeChildSystems(Id systemId) Removes all children from a system.
void	removeRootSystem(Id systemId) Removes a root system.

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

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.

canModifySystemHierarchy

boolean canModifySystemHierarchy()

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.

addRootSystem

void addRootSystem(Id systemId)
                   throws AlreadyExistsException,
                          NotFoundException,
                          OperationFailedException,
                          PermissionDeniedException

Adds a root system.

Parameters:

systemId - the Id of a system

Throws:

AlreadyExistsException - systemId is already in hierarchy

NotFoundException - systemId not found

NullArgumentException - systemId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

removeRootSystem

void removeRootSystem(Id systemId)
                      throws NotFoundException,
                             OperationFailedException,
                             PermissionDeniedException

Removes a root system.

Parameters:

systemId - the Id of a system

Throws:

NotFoundException - systemId is not a root

NullArgumentException - systemId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

addChildSystem

void addChildSystem(Id systemId,
                  Id childId)
                    throws AlreadyExistsException,
                           NotFoundException,
                           OperationFailedException,
                           PermissionDeniedException

Adds a child to a system.

Parameters:

systemId - the Id of a system

childId - the Id of the new child

Throws:

AlreadyExistsException - systemId is already a parent of childId

NotFoundException - systemId or childId not found

NullArgumentException - systemId or childId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

removeChildSystem

void removeChildSystem(Id systemId,
                     Id childId)
                       throws NotFoundException,
                              OperationFailedException,
                              PermissionDeniedException

Removes a child from a system.

Parameters:

systemId - the Id of a system

childId - the Id of the new child

Throws:

NotFoundException - systemId is not parent of childId

NullArgumentException - systemId or childId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

removeChildSystems

void removeChildSystems(Id systemId)
                        throws NotFoundException,
                               OperationFailedException,
                               PermissionDeniedException

Removes all children from a system.

Parameters:

systemId - the Id of a 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.