Package com.verisign.epp.codec.launchpolicy.v01

Class EPPLaunchPolicyPhaseStatus

java.lang.Object
com.verisign.epp.codec.launchpolicy.v01.EPPLaunchPolicyPhaseStatus
All Implemented Interfaces:
EPPCodecComponent, Serializable, Cloneable
public class EPPLaunchPolicyPhaseStatus extends Object implements EPPCodecComponent
EPPLaunchPolicyPhaseStatus defines a supported launch status value. The EPPLaunchPolicyPhaseStatus.Status enumeration includes the possible set of status values with the optional name attribute used when the status is EPPLaunchPolicyPhaseStatus.Status.custom.
See Also:

  • Field Details

  • Constructor Details

    • EPPLaunchPolicyPhaseStatus

      public EPPLaunchPolicyPhaseStatus()
      Default constructor for EPPLaunchPolicyPhaseStatus. The status attribute must be set.

    • EPPLaunchPolicyPhaseStatus

      public EPPLaunchPolicyPhaseStatus(EPPLaunchPolicyPhaseStatus.Status aStatus)
      EPPLaunchPolicyPhaseStatus constructor that takes the required status attribute value.
      Parameters:
      aStatus - Launch phase status value

    • EPPLaunchPolicyPhaseStatus

      public EPPLaunchPolicyPhaseStatus(EPPLaunchPolicyPhaseStatus.Status aStatus, String aName)
      EPPLaunchPolicyPhaseStatus constructor that takes the required status attribute value along with a custom name attribute.
      Parameters:
      aStatus - Launch phase status value
      aName - Custom status name. Set to null if undefined.

    • EPPLaunchPolicyPhaseStatus

      public EPPLaunchPolicyPhaseStatus(EPPLaunchPolicyPhaseStatus.Status aStatus, String aName, String aLang, String aDescription)
      EPPLaunchPolicyPhaseStatus constructor that takes attribute values.
      Parameters:
      aStatus - Phase status value
      aName - OPTIONAL custom status name. Set to null if undefined.
      aLang - OPTIONAL language of the status description with a default of DEFAULT_LANG. Set to DEFAULT_LANG or null to use the default value.
      aDescription - Description of the status rationale

  • Method Details

    • getRootName

      protected String getRootName()
      Gets the root element local name.
      Returns:
      Root element local name.

    • encode

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

    • decode

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

    • equals

      public boolean equals(Object aObject)
      implements a deep EPPLaunchPolicyPhaseStatus compare.
      Overrides:
      equals in class Object
      Parameters:
      aObject - EPPLaunchPolicyPhaseStatus instance to compare with
      Returns:
      true if this object is the same as the aObject argument; false otherwise

    • clone

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

    • hasStatus

      public boolean hasStatus()
      Is the status value defined?
      Returns:
      true if the status is defined; false otherwise.

    • getStatus

      public EPPLaunchPolicyPhaseStatus.Status getStatus()
      Gets the phase status value.
      Returns:
      Phase status value if defined; null otherwise.

    • setStatus

      public void setStatus(EPPLaunchPolicyPhaseStatus.Status aStatus)
      Sets the phase status value.
      Parameters:
      aStatus - The phase status value.

    • hasName

      public boolean hasName()
      Is the name defined?
      Returns:
      true if the name is defined; false otherwise.

    • getName

      public String getName()
      Gets the OPTIONAL custom status name.
      Returns:
      The custom phase name if defined; null otherwise.

    • setName

      public void setName(String aName)
      Sets the OPTIONAL custom status name.
      Parameters:
      aName - Custom status name

    • getLang

      public String getLang()
      Gets the language of the status description with the default set to DEFAULT_LANG.
      Returns:
      Language of description with the default value of DEFAULT_LANG.

    • setLang

      public void setLang(String aLang)
      Sets the language of the status description with the default set to DEFAULT_LANG.
      Parameters:
      aLang - Language of description. If set to null, the value will be set to the default of DEFAULT_LANG.

    • hasDescription

      public boolean hasDescription()
      Is the description defined?
      Returns:
      true if the description is defined; false otherwise.

    • getDescription

      public String getDescription()
      Gets the status description, which is free form text describing the rationale for the status.
      Returns:
      Status description if defined; null otherwise.

    • setDescription

      public void setDescription(String aDesc)
      Sets the status description, which is free form text describing the rationale for the status.
      Parameters:
      aDesc - Status description. Set to null if undefined.

    • getNamespace

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