com.adventnet.nms.provisioning.xml
Class TemplateResult

java.lang.Object
  |
  +--com.adventnet.management.config.xml.BaseElement
        |
        +--com.adventnet.nms.provisioning.xml.TemplateResult

All Implemented Interfaces:

java.io.Serializable

public class TemplateResult

extends BaseElement

The TemplateResult class represents the complete result on execution of a template. It contains StageResults, ConfigResults, DeviceResults and AttributeResults. It also contains name attribute that indicates the name of the template provisioned, status attribute that indicates the overall provisioning operation status as either "SUCCEEDED" or "FAILED" and errorMessage attribute that refers the exception message occured during asynchronous provisioning operation.
Format of TemplateResult will be available as TemplateResult.dtd under
<Provisioning Home>/provisioningtemplates directory.

Since:

2.3

See Also:

StageResult, ConfigResult, DeviceResult, AttributeResult, Serialized Form

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

element, isServer

Constructor Summary

TemplateResult()
Creates a new TemplateResult.

TemplateResult(org.w3c.dom.Element element)
Creates a new TemplateResult that contains representation of the supplied element.

TemplateResult(java.lang.String xmlString)
Creates a new TemplateResult that contains representation of the supplied xml string.

Method Summary

java.lang.String	getErrorMessage() Returns message of the exception occured during asynchronous mode of provisioning.
StageResult	getStageResult(java.lang.String stageId) Returns the StageResult object that is identified by the specified stageId.
java.util.Vector	getStageResults() Returns a vector of all the StageResults that are present in this TemplateResult object.
java.lang.String	getStatus() Returns overall status of the Provisioning Operation.
java.lang.String	getTemplateName() Returns the name of the template provisioned.
void	removeStageResult(java.lang.String stageId) Removes the StageResult object that is identified by the specified stageId from this TemplateResult object.
java.lang.String	toString() Returns the TemplateResult in string form.

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

TemplateResult

public TemplateResult()
               throws InvalidTemplateException

Creates a new TemplateResult.

TemplateResult

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

Creates a new TemplateResult that contains representation of the supplied xml string.

Parameters:

xmlString - xml string for constructing a new TemplateResult object.

TemplateResult

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

Creates a new TemplateResult that contains representation of the supplied element.

Parameters:

element - element for constructing a new TemplateResult.

Method Detail

getTemplateName

public java.lang.String getTemplateName()

Returns the name of the template provisioned.

Returns:

name of the template provisioned.

getStatus

public java.lang.String getStatus()

Returns overall status of the Provisioning Operation. Status may be either "SUCCEEDED" or "FAILED".

Returns:

status of the Provisioning Operation.

getErrorMessage

public java.lang.String getErrorMessage()

Returns message of the exception occured during asynchronous mode of provisioning.

Returns:

message of the exception occured during asynchronous mode of provisioning.

getStageResults

public java.util.Vector getStageResults()

Returns a vector of all the StageResults that are present in this TemplateResult object.

Returns:

a vector of all the StageResults that are present in this TemplateResult object.

getStageResult

public StageResult getStageResult(java.lang.String stageId)

Returns the StageResult object that is identified by the specified stageId.

Parameters:

stageId - unique identifier of the StageResult.

Returns:

the StageResult object that is identified by the specified stageId.

removeStageResult

public void removeStageResult(java.lang.String stageId)

Removes the StageResult object that is identified by the specified stageId from this TemplateResult object.

Parameters:

stageId - unique identifier of the StageResult.

toString

public java.lang.String toString()

Returns the TemplateResult in string form.

Overrides:

toString in class BaseElement

Returns:

the TemplateResult in string form.