Package com.verisign.epp.codec.relateddomainext

Class EPPRelatedDomainExtDomain

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

Title: EPP 1.0 Related Domain - domain tag

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

See Also:

  • Constructor Details

    • EPPRelatedDomainExtDomain

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

      • name - setName
      • auth info - setAuthInfo
      • period - setPeriod
      • current expiration date - setCurrentExpirationDate
      • language - setLanguage

    • EPPRelatedDomainExtDomain

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

    • EPPRelatedDomainExtDomain

      public EPPRelatedDomainExtDomain(String name, EPPRelatedDomainExtAuthInfo authInfo)
      Constructor which takes the name of domain and authInfo
      Parameters:
      name - Domain name
      authInfo - Authorization information

    • EPPRelatedDomainExtDomain

      public EPPRelatedDomainExtDomain(String name, EPPRelatedDomainExtAuthInfo authInfo, String aLanguage)
      Constructor which takes the name of domain, authInfo and a language.
      Parameters:
      name - Domain name
      authInfo - Authorization information
      aLanguage - language

    • EPPRelatedDomainExtDomain

      public EPPRelatedDomainExtDomain(String name, EPPRelatedDomainExtAuthInfo authInfo, EPPRelatedDomainExtPeriod period)
      Constructor which takes the name of domain, authInfo and registration period.
      Parameters:
      name - Domain name
      authInfo - Authorization information
      period - Registration period

    • EPPRelatedDomainExtDomain

      public EPPRelatedDomainExtDomain(String name, EPPRelatedDomainExtAuthInfo authInfo, EPPRelatedDomainExtPeriod period, String aLanguage)
      Constructor which takes the name of domain, authInfo, registration period and a language.
      Parameters:
      name - Domain name
      authInfo - Authorization information
      period - Registration period
      aLanguage - language

    • EPPRelatedDomainExtDomain

      public EPPRelatedDomainExtDomain(String name, Date currentExpirationDate, EPPRelatedDomainExtPeriod period)
      Constructor which takes the name of domain, current expiration date and registration period.
      Parameters:
      name - Domain name
      currentExpirationDate - Current expiration date
      period - Registration period

  • Method Details

    • encode

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

    • decode

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

    • equals

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

    • clone

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

    • getAuthInfo

      public EPPRelatedDomainExtAuthInfo getAuthInfo()
      Returns the authInfo
      Returns:
      the authInfo

    • setAuthInfo

      public void setAuthInfo(EPPRelatedDomainExtAuthInfo aAuthInfo)
      Sets authInfo value to authInfo
      Parameters:
      aAuthInfo - the authInfo to set

    • getPeriod

      public EPPRelatedDomainExtPeriod getPeriod()
      Returns the period
      Returns:
      the period

    • setPeriod

      public void setPeriod(EPPRelatedDomainExtPeriod aPeriod)
      Sets period value to period
      Parameters:
      aPeriod - the period to set

    • getCurrentExpirationDate

      public Date getCurrentExpirationDate()
      Returns the currentExpirationDate
      Returns:
      the currentExpirationDate

    • setCurrentExpirationDate

      public void setCurrentExpirationDate(Date aCurrentExpirationDate)
      Sets currentExpirationDate value to currentExpirationDate
      Parameters:
      aCurrentExpirationDate - the currentExpirationDate to set

    • getLanguage

      public String getLanguage()
      Returns the language
      Returns:
      the language

    • setLanguage

      public void setLanguage(String aLanguage)
      Sets language value to language
      Parameters:
      aLanguage - the language to set

    • hasName

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

    • hasAuthInfo

      public boolean hasAuthInfo()
      Returns:
      true if authInfo is not null.

    • hasPeriod

      public boolean hasPeriod()
      Returns:
      true if period is not null.

    • hasCurrentExpirationDate

      public boolean hasCurrentExpirationDate()
      Returns:
      true if currentExpirationDate is not null.

    • hasLanguage

      public boolean hasLanguage()
      Returns:
      true if language 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.