Package com.verisign.epp.codec.emailFwd

Class EPPEmailFwdDeleteCmd

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

  • A <emailFwd:name> element that contains the fully qualified emailFwd name of the object to be deleted. Use getName and setName to get and set the element.

EPPReponse is the response associated with EPPEmailFwdDeleteCmd.
See Also:

  • Constructor Details

    • EPPEmailFwdDeleteCmd

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

    • EPPEmailFwdDeleteCmd

      public EPPEmailFwdDeleteCmd(String aTransId, String aName)
      EPPEmailFwdDeleteCmd constructor that takes the emailFwd name as an argument.
      Parameters:
      aTransId - Transaction Id associated with command.
      aName - EmailFwd name to delete.

  • Method Details

    • getNamespace

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

    • getKey

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

    • getName

      public String getName()
      Gets the emailFwd name to delete.
      Returns:
      EmailFwd Name String instance if defined; null otherwise.

    • setName

      public void setName(String aName)
      Sets the emailFwd name to delete.
      Parameters:
      aName - EmailFwd Name

    • equals

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

    • clone

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

    • doEncode

      protected Element doEncode(Document aDocument) throws EPPEncodeException
      Encode a DOM Element tree from the attributes of the EPPEmailFwdDeleteCmd 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 EPPEmailFwdDeleteCmd instance.
      Throws:
      EPPEncodeException - Unable to encode EPPEmailFwdDeleteCmd instance.

    • doDecode

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