Package com.verisign.epp.codec.relateddomainext

Class EPPRelatedDomainExtDomainData

java.lang.Object
com.verisign.epp.codec.relateddomainext.EPPRelatedDomainExtDomainData
All Implemented Interfaces:
EPPCodecComponent, Serializable, Cloneable
public class EPPRelatedDomainExtDomainData extends Object implements EPPCodecComponent
EPPCodecComponent that encodes and decodes a <relDom:domain> tag sent in a response. This element contains a number of child elements. Not all of them are required for all the responses listed below in which this element is used.
  • Domain Create Response
  • Domain Delete Response
  • Domain Renew Response
  • Domain Transfer Response

Title: EPP 1.0 Related Domain - domain tag

Description: The EPPRelatedDomainExtDomainData object represents the collection of domains that had been processed atomically. As XML, it is represented by a <relDom:domain> element.

See Also:

  • Field Details

  • Constructor Details

    • EPPRelatedDomainExtDomainData

      public EPPRelatedDomainExtDomainData()
      EPPRelatedDomainExtDomainData default constructor. Must call required setter methods before invoking encode, which may include:

      • name - setName
      • request client - setRequestClient
      • action client - setActionClient
      • transfer status - setTransferStatus
      • request date - setReqeustDate
      • action date - setActionDate
      • expiration date - setExpirationDate
      • created date - setCreatedDate
      • deletion result - setDeleteResult

    • EPPRelatedDomainExtDomainData

      public EPPRelatedDomainExtDomainData(String aName)
      Constructor which takes the name of domain.
      Parameters:
      aName - Domain name

    • EPPRelatedDomainExtDomainData

      public EPPRelatedDomainExtDomainData(String aName, Date aCreationDate, Date aExpirationDate)
      Constructor which takes the name of domain, creation date and expiration date
      Parameters:
      aName - Domain name
      aCreationDate - Creation date of domain name
      aExpirationDate - Expiration date

    • EPPRelatedDomainExtDomainData

      public EPPRelatedDomainExtDomainData(String aName, Date aExpirationDate)
      Constructor which takes the name of domain and expiration date
      Parameters:
      aName - Domain name
      aExpirationDate - Expiration date

    • EPPRelatedDomainExtDomainData

      public EPPRelatedDomainExtDomainData(String aName, String aDeleteResult)
      Constructor which takes the name of domain and deletion result
      Parameters:
      aName - Domain name
      aDeleteResult - Deletion result

    • EPPRelatedDomainExtDomainData

      public EPPRelatedDomainExtDomainData(String aName, String aTransferStatus, String aRequestClient, Date aRequestDate, String aActionClient, Date aActionDate, Date aExpirationDate)
      Constructor which takes the name of domain, transfer status, request client, request date, action client, action date and expiration date.
      Parameters:
      aName - Domain name
      aTransferStatus - Transfer status
      aRequestClient - Requesting client
      aRequestDate - Requesting date
      aActionClient - Acting client
      aActionDate - Action date
      aExpirationDate - Expiration date

  • Method Details

    • encode

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

    • decode

      public void decode(Element aElement) throws EPPDecodeException
      Decode the EPPRelatedDomainExtDomainData attributes from the aElement DOM Element tree.
      Specified by:
      decode in interface EPPCodecComponent
      Parameters:
      aElement - Root DOM Element to decode EPPRelatedDomainExtDomainData from.
      Throws:
      EPPDecodeException - Unable to decode aElement

    • equals

      public boolean equals(Object aObject)
      Compare an instance of EPPRelatedDomainExtDomainData with this instance.
      Overrides:
      equals in class Object
      Parameters:
      aObject - Object to compare with.
      Returns:
      true if equal; false otherwise.

    • clone

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

    • getName

      public String getName()
      Gets the domain name
      Returns:
      Domain Name if set; null otherwise.

    • setName

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

    • getRequestClient

      public String getRequestClient()
      Gets the identifier of the client that initiated the transfer request.
      Returns:
      The Request Client Id String if defined; null otherwise.

    • setRequestClient

      public void setRequestClient(String aRequestClient)
      Sets the identifier of the client that initiated the transfer request.
      Parameters:
      aRequestClient - The Request Client Id String

    • getActionClient

      public String getActionClient()
      Gets the identifier of the client that SHOULD respond to the transfer request.
      Returns:
      The Request Client Id String if defined; null otherwise.

    • setActionClient

      public void setActionClient(String aActionClient)
      Sets the identifier of the client that SHOULD respond to the transfer request.
      Parameters:
      aActionClient - The Action Client Id String

    • getTransferStatus

      public String getTransferStatus()
      Gets the state of the most recent transfer request. This should be one of the EPPResponse.TRANSFER constants.
      Returns:
      The transfer status String if defined; null otherwise.

    • setTransferStatus

      public void setTransferStatus(String aTransferStatus)
      Sets the state of the most recent transfer request. This should be one of the EPPResponse.TRANSFER constants.
      Parameters:
      aTransferStatus - The transfer status String (EPPResponse.TRANSFER)

    • getRequestDate

      public Date getRequestDate()
      Gets the date and time that the transfer was requested.
      Returns:
      The request date and time if defined; null otherwise.

    • setRequestDate

      public void setRequestDate(Date aRequestDate)
      Sets the date and time that the transfer was requested.
      Parameters:
      aRequestDate - The request date and time

    • getActionDate

      public Date getActionDate()
      Gets the date and time of a required or completed response.
      Returns:
      The required or complete response data and time if defined; null otherwise.

    • setActionDate

      public void setActionDate(Date aActionDate)
      Sets the date and time of a required or completed response.
      Parameters:
      aActionDate - The required or complete response data and time.

    • getExpirationDate

      public Date getExpirationDate()
      Gets the optional attribute that contains the end of the domain's validity period if the transfer command caused or causes a change in the validity period.
      Returns:
      Transfer expiration data and time if defined; null otherwise.

    • setExpirationDate

      public void setExpirationDate(Date aExpirationDate)
      Sets the optional attribute that contains the end of the domain's validity period if the transfer command caused or causes a change in the validity period.
      Parameters:
      aExpirationDate - Transfer expiration data and time.

    • getCreatedDate

      public Date getCreatedDate()
      Returns the createdDate
      Returns:
      the createdDate

    • setCreatedDate

      public void setCreatedDate(Date aCreatedDate)
      Sets createdDate value to createdDate
      Parameters:
      aCreatedDate - the createdDate to set

    • getDeleteResult

      public String getDeleteResult()
      Returns the deleteResult
      Returns:
      the deleteResult

    • setDeleteResult

      public void setDeleteResult(String aDeleteResult)
      Sets deleteResult value to deleteResult
      Parameters:
      aDeleteResult - the deleteResult to set

    • hasExpirationDate

      public boolean hasExpirationDate()
      Returns:
      true if expirationDate is not null.

    • hasActionDate

      public boolean hasActionDate()
      Returns:
      true if actionDate is not null.

    • hasActionClient

      public boolean hasActionClient()
      Returns:
      true if actionClient is not null.

    • hasRequestDate

      public boolean hasRequestDate()
      Returns:
      true if requestDate is not null.

    • hasRequestClient

      public boolean hasRequestClient()
      Returns:
      true if requestClient is not null.

    • hasTransferStatus

      public boolean hasTransferStatus()
      Returns:
      true if transferStatus is not null.

    • hasDeleteResult

      public boolean hasDeleteResult()
      Returns:
      true if deleteResult is not null.

    • hasCreatedDate

      public boolean hasCreatedDate()
      Returns:
      true if createdDate is not null.

    • hasName

      public boolean hasName()
      Returns:
      true if name is not null.

    • getNamespace

      public String getNamespace()
      Returns the XML namespace associated with the EPPCodecComponent.
      Specified by:
      getNamespace in interface EPPCodecComponent
      Returns:
      XML namespace for the EPPCodecComponent.