Package com.verisign.epp.codec.contact

Class EPPContactDeleteCmd

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

  • A <contact:id> element that contains the server-unique identifier for the contact to be deleted. Use getId and setId to get and set the element.

EPPReponse is the response associated with EPPContactDeleteCmd.

See Also:

  • Constructor Details

    • EPPContactDeleteCmd

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

    • EPPContactDeleteCmd

      public EPPContactDeleteCmd(String aTransId, String aId)
      EPPContactDeleteCmd constructor that takes the contact id as an argument.
      Parameters:
      aTransId - Transaction Id associated with command.
      aId - Contact id to delete.

  • Method Details

    • getNamespace

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

    • getKey

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

    • doEncode

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

    • doDecode

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

    • getId

      public String getId()
      Gets the contact id to delete.
      Returns:
      Contact Id String instance if defined; null otherwise.

    • setId

      public void setId(String aId)
      Sets the contact id to delete.
      Parameters:
      aId - Contact Id

    • equals

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

    • clone

      public Object clone() throws CloneNotSupportedException
      Clone EPPContactDeleteCmd.
      Specified by:
      clone in interface EPPCodecComponent
      Overrides:
      clone in class EPPCommand
      Returns:
      clone of EPPContactDeleteCmd
      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.