com.prosyst.mprm.admin.system

Interface TreeBrowser

All Known Subinterfaces:

Configurator

public interface TreeBrowser

Manipulates The Gateway Tree.

Version:

1.0.0

Author:

Jordan Simeonov, Rumen Monev

Method Summary

Modifier and Type	Method and Description
GatewayGroup	createNode(java.lang.String parentPath, java.lang.String displayName) Creates a gateway group node under the node specified by the parentPath argument.
GatewayGroup	getGroup(java.lang.String path) Returns a GatewayGroup object identified by the given path.
GatewayGroup	getParent(java.lang.String path) Returns a GatewayGroup object which is the parent of the object identified by the given path into the gateway's tree.
GatewayGroup[]	getSubGroups(java.lang.String path) Returns array of GatewayGroup object immediate children of the group identified by the given path into the gateway's tree.
void	removeNode(java.lang.String path) Removes a gateway group node from the gateways tree.

Method Detail

createNode

GatewayGroup createNode(java.lang.String parentPath,
                        java.lang.String displayName)
                 throws CommunicationException,
                        java.lang.Exception

Creates a gateway group node under the node specified by the parentPath argument.

Parameters:

parentPath - The path of the parent group.

displayName - The name under which the created node will be visualized under the parent group node.

Returns:

GatewayGroup object representing the created gateway group node.

Throws:

{@link - CommunicationException} is thrown if communication fails.

Exception - is thrown if such node already exists, the parent does not exist or some other error occurs.

CommunicationException

java.lang.Exception

removeNode

void removeNode(java.lang.String path)
         throws CommunicationException,
                java.lang.Exception

Removes a gateway group node from the gateways tree.

Parameters:

path - The path of the group to be removed.

Throws:

{@link - CommunicationException} is thrown if communication fails.

Exception - is thrown if the node does not exist or other error occurs.

CommunicationException

java.lang.Exception

getGroup

GatewayGroup getGroup(java.lang.String path)
               throws CommunicationException,
                      java.lang.Exception

Returns a GatewayGroup object identified by the given path.

Parameters:

path - The path of the object.

Returns:

GatewayGroup object.

Throws:

{@link - CommunicationException} is thrown if communication fails.

Exception - is thrown if such group is not present or other error occurs.

CommunicationException

java.lang.Exception

getParent

GatewayGroup getParent(java.lang.String path)
                throws CommunicationException,
                       java.lang.Exception

Returns a GatewayGroup object which is the parent of the object identified by the given path into the gateway's tree.

Parameters:

path - The path of the object.

Returns:

A GatewayGroup object.

Throws:

{@link - CommunicationException} is thrown if communication fails.

Exception - is thrown if the node is not present or other error occurs.

CommunicationException

java.lang.Exception

getSubGroups

GatewayGroup[] getSubGroups(java.lang.String path)
                     throws CommunicationException,
                            java.lang.Exception

Returns array of GatewayGroup object immediate children of the group identified by the given path into the gateway's tree.

Parameters:

path - The path of the object.

Returns:

The array of gateway group objects.

Throws:

{@link - CommunicationException} is thrown if communication fails.

Exception - is thrown if such group is not present or other error occurs.

CommunicationException

java.lang.Exception