Interface SystemHierarchyDesignSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface SystemHierarchyDesignSession
extends OsidSession

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

Method Summary

Modifier and Type	Method	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 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.

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.