Package com.verisign.epp.codec.nameWatch

Class EPPNameWatchDeleteCmd

java.lang.Object
com.verisign.epp.codec.gen.EPPCommand
com.verisign.epp.codec.gen.EPPDeleteCmd
com.verisign.epp.codec.nameWatch.EPPNameWatchDeleteCmd
All Implemented Interfaces:
EPPCodecComponent, EPPMessage, Serializable, Cloneable
public class EPPNameWatchDeleteCmd extends EPPDeleteCmd
Represents an EPP NameWatch <delete> command that allows a client to delete a nameWatch object. The EPP <delete> command provides a transform operation that allows a client to delete a nameWatch object. In addition to the standard EPP command elements, the <delete> command MUST contain a "nameWatch:delete" element that identifies the nameWatch namespace and the location of the nameWatch schema.

  • A <nameWatch:roid> element that contains the fully qualified nameWatch name of the object to be deleted. Use getRoid and setRoid to get and set the element.

EPPReponse is the response associated with EPPNameWatchDeleteCmd.

See Also:

  • Constructor Details

    • EPPNameWatchDeleteCmd

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

    • EPPNameWatchDeleteCmd

      public EPPNameWatchDeleteCmd(String aTransId, String aRoid)
      EPPNameWatchDeleteCmd constructor that takes the nameWatch roid as an argument.
      Parameters:
      aTransId - Transaction Id associated with command.
      aRoid - NameWatch roid to delete.

  • Method Details

    • getNamespace

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

    • getKey

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

    • getRoid

      public String getRoid()
      Gets the nameWatch roid to delete.
      Returns:
      NameWatch roid

    • setRoid

      public void setRoid(String aRoid)
      Sets the nameWatch roid to delete.
      Parameters:
      aRoid - NameWatch roid

    • equals

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

    • clone

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

    • doEncode

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

    • doDecode

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