Package com.verisign.epp.codec.nv

Class EPPNameVerificationCheckResp

java.lang.Object
com.verisign.epp.codec.gen.EPPResponse
com.verisign.epp.codec.nv.EPPNameVerificationCheckResp
All Implemented Interfaces:
EPPCodecComponent, EPPMessage, Serializable, Cloneable
public class EPPNameVerificationCheckResp extends EPPResponse
Provides the response to a EPPNameVerificationCheckCmd that indicates whether or not the labels can be used to create a Domain Name Verification (DNV) object.
See Also:

  • Field Details

    • ELM_LOCALNAME

      public static final String ELM_LOCALNAME
      Constant for the name verification check response
      See Also:

  • Constructor Details

    • EPPNameVerificationCheckResp

      public EPPNameVerificationCheckResp()
      EPPNameVerificationCheckResp default constructor.

    • EPPNameVerificationCheckResp

      public EPPNameVerificationCheckResp(EPPTransId aTransId)
      EPPNameVerificationCheckResp constructor that sets the transaction identifier.
      Parameters:
      aTransId - Transaction Id associated with response.

    • EPPNameVerificationCheckResp

      public EPPNameVerificationCheckResp(EPPTransId aTransId, EPPNameVerificationCheckResult aResult)
      EPPNameVerificationCheckResp constructor that will set the result of an individual label.
      Parameters:
      aTransId - Transaction Id associated with response.
      aResult - Result of a single label.

    • EPPNameVerificationCheckResp

      public EPPNameVerificationCheckResp(EPPTransId aTransId, List<EPPNameVerificationCheckResult> aResults)
      EPPNameVerificationCheckResp constructor that will set the result of multiple labels.
      Parameters:
      aTransId - Transaction Id associated with response.
      aResults - List of EPPNameVerificationCheckResult instances.

  • Method Details

    • getType

      public String getType()
      Get the EPP response type associated with EPPNameVerificationCheckResp.
      Overrides:
      getType in class EPPResponse
      Returns:
      EPPNameVerificationCheckResp.ELM_NAME

    • getNamespace

      public String getNamespace()
      Get the EPP command Namespace associated with EPPNameVerificationCheckResp.
      Specified by:
      getNamespace in interface EPPCodecComponent
      Specified by:
      getNamespace in interface EPPMessage
      Overrides:
      getNamespace in class EPPResponse
      Returns:
      EPPNameVerificationMapFactory.NS

    • equals

      public boolean equals(Object aObject)
      Compare an instance of EPPNameVerificationCheckResp with this instance.
      Overrides:
      equals in class EPPResponse
      Parameters:
      aObject - Object to compare with.
      Returns:
      true if equal; false otherwise.

    • clone

      public Object clone() throws CloneNotSupportedException
      Clone EPPNameVerificationCheckResp.
      Specified by:
      clone in interface EPPCodecComponent
      Overrides:
      clone in class EPPResponse
      Returns:
      clone of EPPNameVerificationCheckResp
      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 EPPResponse
      Returns:
      Indented XML String if successful; ERROR otherwise.

    • addResult

      public void addResult(EPPNameVerificationCheckResult aResult)
      Adds a result to the list of check results.
      Parameters:
      aResult - Result to add.

    • setCheckResults

      public void setCheckResults(List<EPPNameVerificationCheckResult> aResults)
      Set the results of a EPPNameVerificationCheckResp Response. There is one EPPNameVerificationCheckResult instance in aResults for each label requested in the EPPNameVerificationCheckCmd Command.
      Parameters:
      aResults - List of EPPNameVerificationCheckResult instances.

    • getCheckResults

      public List<EPPNameVerificationCheckResult> getCheckResults()
      Get the results of a EPPNameVerificationCheckResp Response.
      Returns:
      List of EPPNameVerificationCheckResult instances.

    • doEncode

      protected Element doEncode(Document aDocument) throws EPPEncodeException
      Encode a DOM Element tree from the attributes of the EPPNameVerificationCheckResp instance.
      Overrides:
      doEncode in class EPPResponse
      Parameters:
      aDocument - DOM Document that is being built. Used as an Element factory.
      Returns:
      Element Root DOM Element representing the EPPNameVerificationCheckResp instance.
      Throws:
      EPPEncodeException - Unable to encode EPPNameVerificationCheckResp instance.

    • doDecode

      protected void doDecode(Element aElement) throws EPPDecodeException
      Decode the EPPNameVerificationCheckResp attributes from the aElement DOM Element tree.
      Overrides:
      doDecode in class EPPResponse
      Parameters:
      aElement - Root DOM Element to decode EPPNameVerificationCheckResp from.
      Throws:
      EPPDecodeException - Unable to decode aElement