Package com.verisign.epp.codec.org

Class EPPOrgCheckResp

java.lang.Object
com.verisign.epp.codec.gen.EPPResponse
com.verisign.epp.codec.org.EPPOrgCheckResp
All Implemented Interfaces:
EPPCodecComponent, EPPMessage, Serializable, Cloneable
public class EPPOrgCheckResp extends EPPResponse
Represents a org <check> response that returns the availability of a set of client-specified but server-unique org identifiers.
See Also:

  • Field Details

  • Constructor Details

    • EPPOrgCheckResp

      public EPPOrgCheckResp()
      EPPOrgCheckResp default constructor. It will set results attribute to an empty List.

    • EPPOrgCheckResp

      public EPPOrgCheckResp(EPPTransId aTransId)
      EPPOrgCheckResp constructor that only takes the transaction identifier.
      Parameters:
      aTransId - transaction Id associated with response

    • EPPOrgCheckResp

      public EPPOrgCheckResp(EPPTransId aTransId, EPPOrgCheckResult aResult)
      EPPOrgCheckResp constructor that takes an individual result. Add more tables using addCheckResult(EPPOrgCheckResult).
      Parameters:
      aTransId - transaction Id associated with response
      aResult - An individual check result

  • Method Details

    • hasCheckResults

      public boolean hasCheckResults()
      Are any results defined in the list of results?
      Returns:
      true if there is at least one result defined; false otherwise.

    • getCheckResults

      public List<EPPOrgCheckResult> getCheckResults()
      Gets the list of results.
      Returns:
      List of results

    • setCheckResults

      public void setCheckResults(List<EPPOrgCheckResult> aResults)
      Sets the list of results.
      Parameters:
      aResults - List of results

    • setCheckResult

      public void setCheckResult(EPPOrgCheckResult aResult)
      Set an individual check result. This method clears the existing list of check results.
      Parameters:
      aResult - An individual check result.

    • addCheckResult

      public void addCheckResult(EPPOrgCheckResult aResult)
      Append a result to the list of results. This method does NOT clear the existing list of results.
      Parameters:
      aResult - A result to add to the list of results

    • doEncode

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

    • doDecode

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

    • getType

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

    • getNamespace

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

    • equals

      public boolean equals(Object aObject)
      Compare an instance of EPPOrgCheckResp with this instance.
      Overrides:
      equals in class EPPResponse
      Parameters:
      aObject - Object to compare with.
      Returns:
      true if this object is the same as the aObject argument; false otherwise

    • clone

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