Package com.verisign.epp.codec.launch

Class EPPLaunchInfo

java.lang.Object
com.verisign.epp.codec.launch.EPPLaunchInfo
All Implemented Interfaces:
EPPCodecComponent, Serializable, Cloneable
public class EPPLaunchInfo extends Object implements EPPCodecComponent
Extension to the domain info command to retrieve information for a launch phase registration or application.
See Also:

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    ELM_LOCALNAME
    Constant for the launch phase info extension local name
    static final String
    ELM_NAME
    Constant for the launch phase info extension tag

  • Constructor Summary

    Constructors
    Constructor
    Description
    EPPLaunchInfo()
    Create an EPPLaunchInf instance
    EPPLaunchInfo(EPPLaunchPhase aPhase)
    Create a EPPLaunchInfo instance with the required phase attribute value.
    EPPLaunchInfo(EPPLaunchPhase aPhase, String aApplicationId)
    Create a EPPLaunchInfo instance with both the required phase and optional application identifier attribute values.

  • Method Summary

    Modifier and Type
    Method
    Description
    Object
    clone()
    Clone EPPLaunchInfo.
    void
    decode(Element aElement)
    Decode the DOM element to the EPPLaunchInfo.
    Element
    encode(Document aDocument)
    Encode the EPPLaunchInfo to a DOM Element
    boolean
    equals(Object aObject)
    implements a deep EPPLaunchInfo compare.
    String
    getApplicationId()
    Gets the application identifier of the launch application.
    String
    getNamespace()
    Returns the XML namespace associated with the EPPCodecComponent.
    EPPLaunchPhase
    getPhase()
    Gets phase during which the application or registration was submitted or is associated with.
    boolean
    isIncludeMark()
    Get the flag indicating whether or not to include the mark in the response.
    void
    setApplicationId(String aApplicationId)
    Sets the application identifier of the launch application.
    void
    setIncludeMark(boolean aIncludeMark)
    Sets the flag for indicating whether or not to include the mark in the response.
    void
    setPhase(EPPLaunchPhase aPhase)
    Sets the phase during which the application or registration was submitted or is associated with.
    void
    setPhase(String aPhaseString)
    Sets the phase with one of the EPPLaunchPhase PHASE constants.

    Methods inherited from class java.lang.Object

    finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Field Details

    • ELM_LOCALNAME

      public static final String ELM_LOCALNAME
      Constant for the launch phase info extension local name
      See Also:

    • ELM_NAME

      public static final String ELM_NAME
      Constant for the launch phase info extension tag
      See Also:

  • Constructor Details

    • EPPLaunchInfo

      public EPPLaunchInfo()
      Create an EPPLaunchInf instance

    • EPPLaunchInfo

      public EPPLaunchInfo(EPPLaunchPhase aPhase)
      Create a EPPLaunchInfo instance with the required phase attribute value.
      Parameters:
      aPhase - Phase during which the application or registration was submitted or is associated with

    • EPPLaunchInfo

      public EPPLaunchInfo(EPPLaunchPhase aPhase, String aApplicationId)
      Create a EPPLaunchInfo instance with both the required phase and optional application identifier attribute values.
      Parameters:
      aPhase - Phase during which the application or registration was submitted or is associated with
      aApplicationId - Application identifier of the launch application

  • Method Details

    • getPhase

      public EPPLaunchPhase getPhase()
      Gets phase during which the application or registration was submitted or is associated with.
      Returns:
      phase during which the application or registration was submitted or is associated with if defined; null otherwise.

    • setPhase

      public void setPhase(EPPLaunchPhase aPhase)
      Sets the phase during which the application or registration was submitted or is associated with.
      Parameters:
      aPhase - Phase during which the application or registration was submitted or is associated with

    • setPhase

      public void setPhase(String aPhaseString)
      Sets the phase with one of the EPPLaunchPhase PHASE constants.
      Parameters:
      aPhaseString - One of the EPPLaunchPhase PHASE constants.

    • getApplicationId

      public String getApplicationId()
      Gets the application identifier of the launch application.
      Returns:
      Application identifier if defined; null otherwise.

    • setApplicationId

      public void setApplicationId(String aApplicationId)
      Sets the application identifier of the launch application.
      Parameters:
      aApplicationId - Application identifier of the launch application

    • isIncludeMark

      public boolean isIncludeMark()
      Get the flag indicating whether or not to include the mark in the response.
      Returns:
      true to include the mark; false otherwise.

    • setIncludeMark

      public void setIncludeMark(boolean aIncludeMark)
      Sets the flag for indicating whether or not to include the mark in the response.
      Parameters:
      aIncludeMark - true to include the mark; false otherwise.

    • clone

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

    • encode

      public Element encode(Document aDocument) throws EPPEncodeException
      Encode the EPPLaunchInfo to a DOM Element
      Specified by:
      encode in interface EPPCodecComponent
      Parameters:
      aDocument - a DOM Document to attach data to.
      Returns:
      The root element of this component.
      Throws:
      EPPEncodeException - Thrown if any errors prevent encoding.

    • decode

      public void decode(Element aElement) throws EPPDecodeException
      Decode the DOM element to the EPPLaunchInfo.
      Specified by:
      decode in interface EPPCodecComponent
      Parameters:
      aElement - DOM Element to decode the attribute values
      Throws:
      EPPDecodeException - Error decoding the DOM Element

    • equals

      public boolean equals(Object aObject)
      implements a deep EPPLaunchInfo compare.
      Overrides:
      equals in class Object
      Parameters:
      aObject - EPPLaunchInfo instance to compare with
      Returns:
      true if equal false 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.