AdventNet Web NMS 4 API Specification

com.adventnet.management.config.xml
Class InventoryInput

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

public class InventoryInput
extends BaseElement

This class represents InventoryInputs defined in a DataSource. These inputs supply inventory data to the ConfigTask which will be populated before configuring these devices.

<?xml version="1.0" encoding="ISO-8859-1"?>
<DataSource name="InventorySource" associatedTasks="SystemConfig">
<InventoryInput id="sysName" MOName="localhost" MOField="sysName" default="NMS"/>
</DataSource>

See Also:
Serialized Form

Fields inherited from class com.adventnet.management.config.xml.BaseElement
element, isServer
 
Constructor Summary
InventoryInput(org.w3c.dom.Element element)
          Creates a new InventoryInput from the XML Element.
InventoryInput(java.lang.String invXML)
          Creates a InventoryInput from the XML String.
 
Method Summary
 java.lang.String getID()
          Returns a uniqueID that will be used to populate this inventory data to the Task.
 java.lang.String getInventoryHandler()
          Returns the handler that provides the Inventory Data to task.
 java.lang.String getMOField()
          Returns the property of the Managed Object.
 java.lang.String getMOName()
          Returns the Managed Object Name that supplies the inventory data.
 
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

InventoryInput

public InventoryInput(org.w3c.dom.Element element)
               throws InvalidTemplateException
Creates a new InventoryInput from the XML Element.
Parameters:
element - element containing InventoryInput as the root element.
Throws:
InvalidTemplateException - if the element is null or element's tag name is not equal to InventoryInput.

InventoryInput

public InventoryInput(java.lang.String invXML)
               throws InvalidTemplateException
Creates a InventoryInput from the XML String.
Parameters:
invXML - a String represents the InventoryInput.
Throws:
InvalidTemplateException - if the String is an invalid XML.
Method Detail

getMOName

public java.lang.String getMOName()
Returns the Managed Object Name that supplies the inventory data.
Returns:
a String representing the MO Name.

getMOField

public java.lang.String getMOField()
Returns the property of the Managed Object.
Returns:
a String representing the MO Property.

getID

public java.lang.String getID()
Returns a uniqueID that will be used to populate this inventory data to the Task. This ID need to be unique among the various inputs defined in a DataSource.
Returns:
a String representing this Inventory Input.

getInventoryHandler

public java.lang.String getInventoryHandler()
Returns the handler that provides the Inventory Data to task.
Returns:
a Class that implements com.adventnet.management.config.InventoryHandler.

AdventNet Web NMS 4 API Specification