Package com.verisign.epp.codec.defReg

Class EPPDefRegUpdateCmd

java.lang.Object
com.verisign.epp.codec.gen.EPPCommand
com.verisign.epp.codec.gen.EPPUpdateCmd
com.verisign.epp.codec.defReg.EPPDefRegUpdateCmd
All Implemented Interfaces:
EPPCodecComponent, EPPMessage, Serializable, Cloneable
public class EPPDefRegUpdateCmd extends EPPUpdateCmd
Represents an EPP DefReg <update> command. The EPP <update> command provides a transform operation that allows a client to modify the attributes of a defReg object. In addition to the standard EPP command elements, the <update> command MUST contain a <defReg:update> element that identifies the defReg namespace. In addition to The <defReg:update> element SHALL contain the following child elements:
  • A <defReg:roid> element that contains the repository object identifier assigned to the defReg object when the object was created.
  • An OPTIONAL <defReg:add> element that contains attribute values to be added to the object.
  • An OPTIONAL <defReg:rem> element that contains attribute values to be removed from the object.
  • An OPTIONAL <defReg:chg> element that contains attribute values to be changed.
See Also:

  • Constructor Details

    • EPPDefRegUpdateCmd

      public EPPDefRegUpdateCmd()
      EPPDefRegUpdateCmd default constructor. The roid is initialized to null. The roid must be set before invoking encode.

    • EPPDefRegUpdateCmd

      public EPPDefRegUpdateCmd(String aTransId, String aRoid, EPPDefRegAddRemove aAdd, EPPDefRegAddRemove aRemove, EPPDefRegAddRemove aChange)
      EPPDefRegUpdateCmd constructor that takes the required attributes as arguments.
      Parameters:
      aTransId - Transaction Id associated with the command.
      aRoid - DefReg roid to update.
      aAdd - DOCUMENT ME!
      aRemove - DOCUMENT ME!
      aChange - Attributes to add to the defReg. null if no additions.

    • EPPDefRegUpdateCmd

      public EPPDefRegUpdateCmd(String aRoid)
      EPPDefRegUpdateCmd default constructor. The roid is initialized to null. The Roid must be set before invoking encode.
      Parameters:
      aRoid - DOCUMENT ME!

  • Method Details

    • getNamespace

      public String getNamespace()
      Gets the EPP command Namespace associated with EPPDefRegUpdateCmd.
      Specified by:
      getNamespace in interface EPPCodecComponent
      Specified by:
      getNamespace in interface EPPMessage
      Specified by:
      getNamespace in class EPPCommand
      Returns:
      EPPDefRegMapFactory.NS

    • getKey

      public String getKey()
      Gets the key for the defensive registration object, which is the defensive registration ROID.
      Overrides:
      getKey in class EPPCommand
      Returns:
      The defensive registration ROID if set; null otherwise.

    • doEncode

      protected Element doEncode(Document aDocument) throws EPPEncodeException
      Encode a DOM Element tree from the attributes of the EPPDefRegUpdateCmd instance.
      Specified by:
      doEncode in class EPPUpdateCmd
      Parameters:
      aDocument - DOM Document that is being built. Used as an Element factory.
      Returns:
      Root DOM Element representing the EPPDefRegUpdateCmd instance.
      Throws:
      EPPEncodeException - Unable to encode EPPDefRegUpdateCmd instance.

    • doDecode

      protected void doDecode(Element aElement) throws EPPDecodeException
      Decode the EPPDefRegUpdateCmd attributes from the aElement DOM Element tree.
      Specified by:
      doDecode in class EPPUpdateCmd
      Parameters:
      aElement - Root DOM Element to decode EPPDefRegUpdateCmd from.
      Throws:
      EPPDecodeException - Unable to decode aElement

    • equals

      public boolean equals(Object aObject)
      Compare an instance of EPPDefRegUpdateCmd with this instance.
      Overrides:
      equals in class EPPUpdateCmd
      Parameters:
      aObject - Object to compare with.
      Returns:
      DOCUMENT ME!

    • clone

      public Object clone() throws CloneNotSupportedException
      Clone EPPDefRegUpdateCmd.
      Specified by:
      clone in interface EPPCodecComponent
      Overrides:
      clone in class EPPCommand
      Returns:
      clone of EPPDefRegUpdateCmd
      Throws:
      CloneNotSupportedException - standard Object.clone exception

    • toString

      public String toString()
      Implementation of Object.toString, which will result in an indented XML String representation of the concrete EPPCodecComponent.
      Overrides:
      toString in class EPPCommand
      Returns:
      Indented XML String if successful; ERROR otherwise.

    • getRoid

      public String getRoid()
      Gets the defReg roid to update.
      Returns:
      DefReg roid if defined; null otherwise.

    • setRoid

      public void setRoid(String aRoid)
      Sets the defReg roid to update.
      Parameters:
      aRoid - DefReg Roid

    • getChange

      public EPPDefRegAddRemove getChange()
      Gets the items to change to the defReg.
      Returns:
      Object that contains the list of elements to change to the defReg if defined; null otherwise.

    • setChange

      public void setChange(EPPDefRegAddRemove newChange)
      Sets the items to change to the defReg.
      Parameters:
      newChange - Object that contains the list of elements to change to the defRegdefRegdefReg.

    • getAdd

      public EPPDefRegAddRemove getAdd()
      Gets the items to add to the DefReg.
      Returns:
      Object that contains the list of elements to add to the DefReg if defined; null otherwise.

    • setAdd

      public void setAdd(EPPDefRegAddRemove aAdd)
      Sets the items to add to the DefReg.
      Parameters:
      aAdd - Object that contains the list of elements to add to the DefReg.

    • getRemove

      public EPPDefRegAddRemove getRemove()
      Gets the items to remove from the DefReg.
      Returns:
      Object that contains the list of elements to remove from the DefReg if defined; null otherwise.

    • setRemove

      public void setRemove(EPPDefRegAddRemove aRemove)
      Sets the items to remove from the DefReg.
      Parameters:
      aRemove - Object that contains the list of elements to remove from the DefReg.