com.funambol.syncclient.spdm
Interface ManagementNode

All Known Implementing Classes:
NodeImpl

public interface ManagementNode

This interface models a device management node. A management not can be either a configuration context (a tree element that contains other nodes) or a configuration node (which instead contains configuration properties).

Version:
$Id: ManagementNode.java,v 1.3 2007-12-22 18:09:17 nichele Exp $

Method Summary
 ManagementNode getChildNode(java.lang.String context)
          Retrieves the subnode with the given name
 ManagementNode[] getChildren()
          Retrieves the children subnodes of the current node.
 java.lang.String getContext()
          Returns the node's context
 java.lang.String getFullContext()
          Returns the entire node's context path (concatenation of all parent context paths).
 java.lang.Object getManagementObject(java.lang.String node)
          Reads the properties of the given node and creates an object with the values read.
 java.lang.Object getNodeValue(java.lang.String node, java.lang.String name)
          Retrieves a value from the given management subnode name.
 java.util.Hashtable getNodeValues(java.lang.String node)
          Retrieves all values in the given management subnode name.
 ManagementNode getParent()
          Retrieves this node's parent.
 java.lang.Object getValue(java.lang.String name)
          Returns the given config parameter
 java.util.Hashtable getValues()
           
 void removeNode(java.lang.String node)
          Remove subnode from configuration three.
 void setValue(java.lang.String name, java.lang.Object value)
          Sets the node value as a whole object.
 void setValue(java.lang.String node, java.lang.String name, java.lang.Object value)
          Sets a subnode specific value.
 

Method Detail

getContext

java.lang.String getContext()
Returns the node's context

Returns:
the node's context

getFullContext

java.lang.String getFullContext()
Returns the entire node's context path (concatenation of all parent context paths).

Returns:
the entire node's context path

getValue

java.lang.Object getValue(java.lang.String name)
                          throws DMException
Returns the given config parameter

Parameters:
name - the configration parameter name
Returns:
this node value
Throws:
DMException - in case of errors.

getValues

java.util.Hashtable getValues()
                              throws DMException
Returns:
hashtable of values
Throws:
DMException - in case of errors.

getNodeValue

java.lang.Object getNodeValue(java.lang.String node,
                              java.lang.String name)
                              throws DMException
Retrieves a value from the given management subnode name.

Parameters:
node - the subnode containing the config value specified by name
name - the name of the configuration value to return
Returns:
the node value
Throws:
DMException - in case of errors.

getNodeValues

java.util.Hashtable getNodeValues(java.lang.String node)
                                  throws DMException
Retrieves all values in the given management subnode name.

Parameters:
node - the subnode containing the required config values
Returns:
the node values
Throws:
DMException - in case of errors.

getManagementObject

java.lang.Object getManagementObject(java.lang.String node)
                                     throws DMException
Reads the properties of the given node and creates an object with the values read.

Parameters:
node - the subnode containing the required config values
Returns:
the object
Throws:
DMException - in case of errors.

getChildren

ManagementNode[] getChildren()
                             throws DMException
Retrieves the children subnodes of the current node.

Returns:
an array of ManagementNode containing this node's children
Throws:
DMException - in case of errors.

getChildNode

ManagementNode getChildNode(java.lang.String context)
                            throws DMException
Retrieves the subnode with the given name

Returns:
context the subnode context (name)
Throws:
DMException - in case of errors.

getParent

ManagementNode getParent()
                         throws DMException
Retrieves this node's parent.

Returns:
the node's parent
Throws:
DMException - in case of errors.

setValue

void setValue(java.lang.String name,
              java.lang.Object value)
              throws DMException
Sets the node value as a whole object.

Parameters:
name - the configuration parameter name
value - the value
Throws:
DMException - in case of errors.

setValue

void setValue(java.lang.String node,
              java.lang.String name,
              java.lang.Object value)
              throws DMException
Sets a subnode specific value.

Parameters:
node - subnode to set
name - configuration parameter to set
value -
Throws:
DMException - in case of errors.

removeNode

void removeNode(java.lang.String node)
                throws DMException
Remove subnode from configuration three.

Parameters:
node - subnode to reomove
Throws:
DMException - in case of errors.


Copyright © 2010 Funambol. All Rights Reserved.