Package com.verisign.epp.codec.launch

Class EPPLaunchStatus

java.lang.Object
com.verisign.epp.codec.launch.EPPLaunchStatus
All Implemented Interfaces:
EPPCodecComponent, Serializable, Cloneable
public class EPPLaunchStatus extends Object implements EPPCodecComponent
Launch application status constants that are returned by EPPLaunchInfData.getStatus() or set with EPPLaunchInfData.setStatus(EPPLaunchStatus).
See Also:

  • Field Details

    • STATUS_PENDING_VALIDATION

      public static final String STATUS_PENDING_VALIDATION
      The initial state of a newly-created application object. The application requires validation, but the validation process has not yet completed.
      See Also:

    • STATUS_VALIDATED

      public static final String STATUS_VALIDATED
      The application meets relevant registry rules.
      See Also:

    • STATUS_INVALID

      public static final String STATUS_INVALID
      The application does not validate according to registry rules.
      See Also:

    • STATUS_PENDING_ALLOCATION

      public static final String STATUS_PENDING_ALLOCATION
      The allocation of the application is pending based on the results of some out-of-band process (for example, an auction).
      See Also:

    • STATUS_ALLOCATED

      public static final String STATUS_ALLOCATED
      One of two possible end states of an application object; the object corresponding to the application has been provisioned.
      See Also:

    • STATUS_REJECTED

      public static final String STATUS_REJECTED
      The other possible end state; the object was not provisioned.
      See Also:

    • STATUS_CUSTOM

      public static final String STATUS_CUSTOM
      A custom status that is defined using the "name" attribute.
      See Also:

    • ELM_LOCALNAME

      public static final String ELM_LOCALNAME
      Constant for the status local name
      See Also:

    • ELM_NAME

      public static final String ELM_NAME
      Constant for the status qualified name (prefix and local name)
      See Also:

    • ATTR_STATUS

      public static final String ATTR_STATUS
      Status attribute key
      See Also:

    • ATTR_NAME

      public static final String ATTR_NAME
      OPTIONAL attribute name that can define a sub-status or the full name of the status when the <launch:status> element has the "custom" value.
      See Also:

  • Constructor Details

    • EPPLaunchStatus

      public EPPLaunchStatus()
      Default constructor. The status value MUST be set using the setStatus(String) method.

    • EPPLaunchStatus

      public EPPLaunchStatus(String aStatus)
      Create EPPLaunchStatus instance with a defined status value.
      Parameters:
      aStatus - Status value using one of the STATUS constants.

    • EPPLaunchStatus

      public EPPLaunchStatus(String aStatus, String aName)
      Create EPPLaunchStatus instance with a defined status value and with the status name value.
      Parameters:
      aStatus - Status value using one of the STATUS constants.
      aName - Name of sub-status or full name of status when aStatus is set to STATUS_CUSTOM.

    • EPPLaunchStatus

      public EPPLaunchStatus(String aStatus, String aName, String aDescription, String aDescriptionLang)
      Create EPPLaunchStatus instance with all attributes.
      Parameters:
      aStatus - Status value using one of the STATUS constants.
      aName - Name of sub-status or full name of status when aStatus is set to STATUS_CUSTOM.
      aDescription - human-readable text that describes the rationale for the status applied to the object.
      aDescriptionLang - The OPTIONAL "lang" attribute, as defined in [RFC5646], MAY be present to identify the language if the negotiated value is something other than the default value of "en" (English).

  • Method Details

    • getStatus

      public String getStatus()
      Gets the status value, which should match one of the STATUS constants.
      Returns:
      Status value

    • setStatus

      public void setStatus(String aStatus)
      Sets the status value.
      Parameters:
      aStatus - Status value, which should be one of the STATUS constants.

    • getName

      public String getName()
      Gets the OPTIONAL status name or sub-status name.
      Returns:
      The status name or sub-status name if defined; null otherwise.

    • setName

      public void setName(String aName)
      Sets the OPTIONAL status name or sub-status name.
      Parameters:
      aName - Status name

    • hasDescription

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

    • getDescription

      public String getDescription()
      Gets the free-form description of the rationale for the status.
      Returns:
      The free-form description of the rationale for the status if defined; null otherwise.

    • setDescription

      public void setDescription(String aDescription)
      Sets the free-form description of the rationale for the status.
      Parameters:
      aDescription - Free-form description of the rationale for the status.

    • hasDescriptionLang

      public boolean hasDescriptionLang()
      Is the description language defined with a non-default value??
      Returns:
      true if the description language is defined; false otherwise.

    • getDescriptionLang

      public String getDescriptionLang()
      Gets the description language value.
      Returns:
      Description language if defined; DEFAULT_LANG otherwise.

    • setDescriptionLang

      public void setDescriptionLang(String aDescriptionLang)
      Sets the description language value.
      Parameters:
      aDescriptionLang - Description language for reason value.

    • clone

      public Object clone() throws CloneNotSupportedException
      Clone EPPLaunchStatus.
      Specified by:
      clone in interface EPPCodecComponent
      Overrides:
      clone in class Object
      Returns:
      clone of EPPLaunchStatus
      Throws:
      CloneNotSupportedException - standard Object.clone exception

    • decode

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

    • encode

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

    • equals

      public boolean equals(Object aObject)
      implements a deep EPPLaunchStatus compare.
      Overrides:
      equals in class Object
      Parameters:
      aObject - EPPLaunchStatus instance to compare with
      Returns:
      true if equal; false otherwise

    • 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.

    • getNamespace

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