Package com.verisign.epp.codec.launch

Class EPPLaunchChkData

java.lang.Object
com.verisign.epp.codec.launch.EPPLaunchChkData
All Implemented Interfaces:
EPPCodecComponent, Serializable, Cloneable
public class EPPLaunchChkData extends Object implements EPPCodecComponent
The extension to a response to a claims check command.
See Also:

  • Field Details

  • Constructor Details

    • EPPLaunchChkData

      public EPPLaunchChkData()
      EPPLaunchCheckResp default constructor. The results list will be empty.

    • EPPLaunchChkData

      public EPPLaunchChkData(EPPLaunchPhase aPhase)
      EPPLaunchCheckResp constructor that takes only the transId attribute.
      Parameters:
      aPhase - One of the EPPLaunchPhase PHASE constants.

    • EPPLaunchChkData

      public EPPLaunchChkData(EPPLaunchCheckResult aResult)
      EPPLaunchCheckResp constructor that will set the result of an individual domain without a phase.
      Parameters:
      aResult - Result of a single domain name.

    • EPPLaunchChkData

      public EPPLaunchChkData(List<EPPLaunchCheckResult> aResults)
      EPPLaunchCheckResp constructor that will set the result of multiple domains without a phase.
      Parameters:
      aResults - List of claims check results

    • EPPLaunchChkData

      public EPPLaunchChkData(EPPLaunchPhase aPhase, EPPLaunchCheckResult aResult)
      EPPLaunchCheckResp constructor that will set the result of an individual domain.
      Parameters:
      aPhase - One of the EPPLaunchPhase PHASE constants.
      aResult - Result of a single domain name.

    • EPPLaunchChkData

      public EPPLaunchChkData(EPPLaunchPhase aPhase, List<EPPLaunchCheckResult> aResults)
      EPPLaunchCheckResp constructor that will set the result of multiple domains.
      Parameters:
      aPhase - One of the EPPLaunchPhase PHASE constants.
      aResults - List of claims check results

  • Method Details

    • getType

      public String getType()
      Get the EPP response type associated with EPPLaunchCheckResp .
      Returns:
      EPPLaunchCheckResp.ELM_NAME

    • getNamespace

      public String getNamespace()
      Get the EPP command Namespace associated with EPPLaunchCheckResp.
      Specified by:
      getNamespace in interface EPPCodecComponent
      Returns:
      EPPLaunchMapFactory.NS

    • equals

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

    • clone

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

    • hasPhase

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

    • getPhase

      public EPPLaunchPhase getPhase()
      Gets phase of the check response.
      Returns:
      phase of the check response if set; null otherwise.

    • setPhase

      public void setPhase(EPPLaunchPhase aPhase)
      Sets the phase of the check response.
      Parameters:
      aPhase - One of the EPPLaunchPhase PHASE constants.

    • setPhase

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

    • getCheckResults

      public List<EPPLaunchCheckResult> getCheckResults()
      Get the results of a EPPLaunchCheckResp Response. There is one EPPLaunchCheckResult instance in this.results for each domain requested in the Claims Check Command.
      Returns:
      List of results if defined; empty list otherwise.

    • setCheckResults

      public void setCheckResults(List<EPPLaunchCheckResult> aResults)
      Set the results of a EPPLaunchCheckResp Response. There is one EPPLaunchCheckResult instance in this.results for each domain requested in the Claims Check Command.
      Parameters:
      aResults - List of claims check results

    • addCheckResult

      public void addCheckResult(EPPLaunchCheckResult aResult)
      Add a claims check result to the list of results.
      Parameters:
      aResult - Claims check result to add to the list.

    • setCheckResult

      public void setCheckResult(EPPLaunchCheckResult aResult)
      Sets the claims result of an individual domain name.
      Parameters:
      aResult - Claims check result to set

    • encode

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

    • decode

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

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