AdventNet Web NMS 4 API Specification

com.adventnet.nms.provisioning.xml
Class Stage

java.lang.Object
  |
  +--com.adventnet.management.config.xml.BaseElement
        |
        +--com.adventnet.nms.provisioning.xml.Stage
All Implemented Interfaces:
java.io.Serializable

public class Stage
extends BaseElement

The Stage class represents a Stage element present in the Template. A Stage can contain InventoryInput, NEInput, Form, ConfigTask, InventoryUpdate, Script, GoTo elements. A Stage should have an attribute "label". The value of this attribute should be unique for the whole Template. If the value is repeated anywhere in the Template, then InvalidTemplateException will be thrown.

Since:
3.0
See Also:
Serialized Form

Fields inherited from class com.adventnet.management.config.xml.BaseElement
element, isServer
 
Constructor Summary
Stage()
          Creates a new Stage instance.
Stage(org.w3c.dom.Element element)
          Creates a new Stage that represents the supplied xml element.
Stage(java.lang.String xmlString)
          Creates a new Stage object that contains representation of the supplied xml string.
 
Method Summary
 java.util.Vector getConfigTasks()
          Returns the ConfigTasks that are present in this Stage.
 java.util.Vector getForms()
          Returns the Forms that are present in this Stage.
 java.util.Vector getGoTos()
          Returns the GoTo elements that are present in this Stage.
 java.util.Vector getInitializations()
          Returns Initialization present in the Stage.
 java.util.Vector getInventoryInputs()
          Returns the InventoryInputs that are present in this Stage.
 java.util.Vector getInventoryUpdates()
          Returns the InventoryUpdates that are present in this Stage.
 java.lang.String getLabel()
          Returns the value of "label" attribute of this Stage element.
 java.util.Vector getNEInputs()
          Returns the NEInputs that are present in this Stage.
 java.util.Vector getScripts()
          Returns the Scripts that are present in this Stage.
 void setLabel(java.lang.String label)
          Sets the label of this Stage.
 
Methods inherited from class com.adventnet.management.config.xml.BaseElement
addSubTag, getAttribute, getElement, getProperties, getSubTagsByName, hasAttribute, removeSubTagsByName, setAttribute, setProperties, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

Stage

public Stage(org.w3c.dom.Element element)
      throws InvalidTemplateException
Creates a new Stage that represents the supplied xml element.
Parameters:
element - xml element that represents this Stage object.
Throws:
InvalidTemplateException - if an specified element is null.

Stage

public Stage(java.lang.String xmlString)
      throws InvalidTemplateException
Creates a new Stage object that contains representation of the supplied xml string.
Parameters:
xmlString - xml string that contains the stage.
Throws:
InvalidTemplateException - if any error occurs.

Stage

public Stage()
Creates a new Stage instance.
Method Detail

getLabel

public java.lang.String getLabel()
Returns the value of "label" attribute of this Stage element.
Returns:
the value of "label" attribute of this Stage element.

setLabel

public void setLabel(java.lang.String label)
Sets the label of this Stage.
Parameters:
label - label of this Stage.

getInitializations

public java.util.Vector getInitializations()
Returns Initialization present in the Stage.
Returns:
vector of Initialization objects

getInventoryInputs

public java.util.Vector getInventoryInputs()
Returns the InventoryInputs that are present in this Stage.
Returns:
a vector containing the InventoryInputs present in this Stage.

getNEInputs

public java.util.Vector getNEInputs()
Returns the NEInputs that are present in this Stage.
Returns:
a vector containing NEInputs present in this Stage.

getForms

public java.util.Vector getForms()
Returns the Forms that are present in this Stage.
Returns:
a vector containing Forms present in this Stage.

getConfigTasks

public java.util.Vector getConfigTasks()
Returns the ConfigTasks that are present in this Stage.
Returns:
a vector containing ConfigTasks present in this Stage.

getScripts

public java.util.Vector getScripts()
Returns the Scripts that are present in this Stage.
Returns:
a vector containing Scripts present in this Stage.

getInventoryUpdates

public java.util.Vector getInventoryUpdates()
Returns the InventoryUpdates that are present in this Stage.
Returns:
a vector containing InventoryUpdates present in this Stage.

getGoTos

public java.util.Vector getGoTos()
Returns the GoTo elements that are present in this Stage.
Returns:
a vector containing GoTo elements present in this Stage.

AdventNet Web NMS 4 API Specification