com.adventnet.management.config.xml
Class ConfigResult

java.lang.Object
  com.adventnet.management.config.xml.BaseElement
      com.adventnet.management.config.xml.ConfigResult

All Implemented Interfaces:

java.io.Serializable

public class ConfigResult
extends BaseElement

This class represents the complete information on the status of configuration of the device.

Sample Configuration Result:

<?xml version="1.0" encoding="ISO-8859-1"?>
<ConfigResult taskName="SystemConfig" rollbackEnabled="false">
<DeviceResult deviceName="192.168.4.19" configuration="Attempted">
<AttributeResult identifier="1.6.0" label="sysLocation" errorStatus="0" message="Success"/>
</DeviceResult>
<DeviceResult deviceName="192.168.4.24" configuration="Attempted">
<AttributeResult identifier="1.6.0" label="sysLocation" errorStatus="0" message="Success"/>
</DeviceResult>
</ConfigResult>

See Also:

DeviceResult, AttributeResult, Serialized Form

Field Summary

Fields inherited from class com.adventnet.management.config.xml.BaseElement

element, isServer

Constructor Summary

ConfigResult(DeviceResult[] deviceResults)
This is an constructor which takes DeviceResult array as an argument

ConfigResult(org.w3c.dom.Element element)
This is a constructor which takes XML Element as an argument.

ConfigResult(java.lang.String xmlString)
This is a constructor which takes XML String as the argument.

Method Summary

DeviceResult[]	getConfigResult() Returns the Configuration Result of the submitted devices.
java.lang.String	getTaskName() Returns the name of the ConfigTask executed over a set of devices.
boolean	isRollbackEnabled() Returns whether rollback is enabled for this configured task.
java.lang.String	toString() Returns the ConfigResult in XML format by transforming the ConfigResult Element.

Methods inherited from class com.adventnet.management.config.xml.BaseElement

addSubTag, getAttribute, getElement, getProperties, getSubTagsByName, hasAttribute, removeSubTagsByName, setAttribute, setProperties

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ConfigResult

public ConfigResult(java.lang.String xmlString)
             throws InvalidTemplateException

This is a constructor which takes XML String as the argument.

Parameters:

xmlString - XML that represents the Configuration Result.

Throws:

InvalidTemplateException - if the xmlString passed is invalid or if root element is not equal to ConfigResult.

ConfigResult

public ConfigResult(org.w3c.dom.Element element)
             throws InvalidTemplateException

This is a constructor which takes XML Element as an argument.

Parameters:

element - element containing ConfigResult as the root element.

Throws:

InvalidTemplateException - if the input Element is null or element's tag name is not equal to ConfigResult.

ConfigResult

public ConfigResult(DeviceResult[] deviceResults)
             throws InvalidTemplateException

This is an constructor which takes DeviceResult array as an argument

Parameters:

deviceResults - an array of DeviceResults whic hwill constitute the ConfigResult.

Throws:

InvalidTemplateException - if the input DeviceResult array is null.

Method Detail

getConfigResult

public DeviceResult[] getConfigResult()

Returns the Configuration Result of the submitted devices.

Returns:

a DeviceResult[] value

getTaskName

public java.lang.String getTaskName()

Returns the name of the ConfigTask executed over a set of devices.

Returns:

task's name executed over a set of devices.

isRollbackEnabled

public boolean isRollbackEnabled()

Returns whether rollback is enabled for this configured task.

Returns:

true if rollback is enabled, else false.

toString

public java.lang.String toString()

Returns the ConfigResult in XML format by transforming the ConfigResult Element.

Overrides:

toString in class BaseElement

Returns:

String value of the ConfigResult.