AdventNet Web NMS 4 API Specification

com.adventnet.nms.provisioning.xml
Class MOUpdate

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

public class MOUpdate
extends BaseElement

The MOUpdate class represents Managed Object update data in the templates. After provisioning operation is completed on a device, the corresponding managed object in the database is updated through MOUpdates present in the Template. The user can use this MOUpdate element for updating Topology database. For updating databases other than Topology database, users can use SQLUpdate element.

Usage of Tag in Template:
<MOUpdate MOName="localhost" MOClass="com.adventnet.nms.topodb.ManagedObject" isNew="false" when="onFailure" >
   <Property name="displayName" value="localhost"/>
</MOUpdate>
MOName is the name of the Managed Object to be updated.
MOClass is the class name of the Managed Object.
If the value of the attribute "isNew" is true, then a new Managed Object will be added to the database, else the existing Managed Object present in the database is updated.
"when" attribute indicates the criteria for updating the database, whether on success or failure.
The properties to be updated are specified using the Property tags.

Since:
2.3
See Also:
SQLUpdate, InventoryUpdate, Serialized Form

Fields inherited from class com.adventnet.management.config.xml.BaseElement
element, isServer
 
Constructor Summary
MOUpdate()
          Creates a new MOUpdate instance.
MOUpdate(org.w3c.dom.Element element)
          Creates a new MOUpdate that contains representaion of the supplied xml element.
MOUpdate(java.lang.String xmlString)
          Creates a new MOUpdate object that contains representation of the supplied xml string.
 
Method Summary
 java.lang.String getIsNew()
          Fetches unique identifier associated with this MOUpdate.
 java.lang.String getMOClass()
          Fetches the class name of the Managed Object which need to be updated.
 java.lang.String getMOName()
          Fetches the name of the Managed Object which need to be updated.
 java.util.Vector getPropertyElements()
          Fetches all the Property elements in this InventoryUpdate.
 java.lang.String getWhen()
          Fetches when attribute value.
 void setIsNew(java.lang.String isNew)
          Sets unique identifier associated with this MOUpdate.
 void setMOClass(java.lang.String moClass)
          Sets the class name of the Managed Object.
 void setMOName(java.lang.String moName)
          Sets the name of the Managed Object which need to be updated.
 void setWhen(java.lang.String when)
          Sets when attribute value to the specified one.
 
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

MOUpdate

public MOUpdate(org.w3c.dom.Element element)
         throws InvalidTemplateException
Creates a new MOUpdate that contains representaion of the supplied xml element.
Parameters:
element - element that represents MOUpdate.
Throws:
InvalidTemplateException - if an error occurs

MOUpdate

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

MOUpdate

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

getPropertyElements

public java.util.Vector getPropertyElements()
Fetches all the Property elements in this InventoryUpdate.
Returns:
Vector of Property elements present in the InventoryUpdate.

getMOName

public java.lang.String getMOName()
Fetches the name of the Managed Object which need to be updated.
Returns:
Value of "MOName" attribute of this MOUpdate.

setMOName

public void setMOName(java.lang.String moName)
Sets the name of the Managed Object which need to be updated.
Parameters:
moName - value of "MOName" attribute of this MOUpdate.

getMOClass

public java.lang.String getMOClass()
Fetches the class name of the Managed Object which need to be updated.
Returns:
Value of "MOClass" attribute of this MOUpdate.

setMOClass

public void setMOClass(java.lang.String moClass)
Sets the class name of the Managed Object.
Parameters:
moClass - value of "MOClass" attribute of this MOUpdate.

getIsNew

public java.lang.String getIsNew()
Fetches unique identifier associated with this MOUpdate.
Returns:
Value of "isNew" attribute of this MOUpdate.

setIsNew

public void setIsNew(java.lang.String isNew)
Sets unique identifier associated with this MOUpdate.
Parameters:
isNew - value of "isNew" attribute of this MOUpdate.

getWhen

public java.lang.String getWhen()
Fetches when attribute value.
Returns:
value of "when" attribute of this MOUpdate.

setWhen

public void setWhen(java.lang.String when)
Sets when attribute value to the specified one.
Parameters:
when - value of "when" attribute of this MOUpdate.

AdventNet Web NMS 4 API Specification