Class EPPDomainPendActionMsg

java.lang.Object
com.verisign.epp.codec.gen.EPPResponse
com.verisign.epp.codec.domain.EPPDomainPendActionMsg
All Implemented Interfaces:
EPPCodecComponent, EPPMessage, Serializable, Cloneable

public class EPPDomainPendActionMsg extends EPPResponse
Poll message used to indicate the result of a pending action. Pending action can included domain create, update, renew, transfer, and delete.
See Also:
  • Field Details

  • Constructor Details

    • EPPDomainPendActionMsg

      public EPPDomainPendActionMsg()
      EPPDomainPendActionMsg default constructor. Must call required setter methods before encode.
    • EPPDomainPendActionMsg

      public EPPDomainPendActionMsg(EPPTransId aTransId, String aName, boolean aSuccess, EPPTransId aPendingTransId, Date aPendingDate)
      EPPDomainPendActionMsg constructor that takes all of the required attributes.
      Parameters:
      aTransId - Poll command transaction id
      aName - Domain name of pending action
      aSuccess - Was the pending action successful
      aPendingTransId - Pending action transaction id
      aPendingDate - Date of pending action completion
  • Method Details

    • getType

      public String getType()
      Gets the EPP command type associated with EPPDomainPendActionMsg.
      Overrides:
      getType in class EPPResponse
      Returns:
      EPPDomainPendActionMsg.ELM_NAME
    • getNamespace

      public String getNamespace()
      Gets the EPP command Namespace associated with EPPDomainPendActionMsg.
      Specified by:
      getNamespace in interface EPPCodecComponent
      Specified by:
      getNamespace in interface EPPMessage
      Overrides:
      getNamespace in class EPPResponse
      Returns:
      EPPDomainMapFactory.NS
    • getName

      public String getName()
      Gets the domain name
      Returns:
      Domain Name String instance if defined; null otherwise.
    • setName

      public void setName(String aName)
      Sets the domain name.
      Parameters:
      aName - Domain Name
    • getPendingDate

      public Date getPendingDate()
      Gets the date that the pending action was completed.
      Returns:
      Returns the pendingDate.
    • setPendingDate

      public void setPendingDate(Date pendingDate)
      Sets the date that the pending action was completed.
      Parameters:
      pendingDate - The pendingDate to set.
    • getPendingTransId

      public EPPTransId getPendingTransId()
      Gets the pending transaction id.
      Returns:
      Returns the pendingTransId.
    • setPendingTransId

      public void setPendingTransId(EPPTransId pendingTransId)
      Sets the pending transaction id.
      Parameters:
      pendingTransId - The pendingTransId to set.
    • isPASuccess

      public boolean isPASuccess()
      Was the pending action successful?
      Returns:
      Returns true if the pending action was successfully completed; false otherwise.
    • setPASuccess

      public void setPASuccess(boolean success)
      Sets if the pending action was successful.
      Parameters:
      success - The success to set.
    • equals

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

      public Object clone() throws CloneNotSupportedException
      Clone EPPDomainPendActionMsg.
      Specified by:
      clone in interface EPPCodecComponent
      Overrides:
      clone in class EPPResponse
      Returns:
      clone of EPPDomainPendActionMsg
      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 EPPResponse
      Returns:
      Indented XML String if successful; ERROR otherwise.
    • doEncode

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

      protected void doDecode(Element aElement) throws EPPDecodeException
      Decode the EPPDomainPendActionMsg attributes from the aElement DOM Element tree.
      Overrides:
      doDecode in class EPPResponse
      Parameters:
      aElement - Root DOM Element to decode EPPDomainPendActionMsg from.
      Throws:
      EPPDecodeException - Unable to decode aElement