Package com.verisign.epp.codec.fee.v1_0

Class EPPFeeChkData

java.lang.Object
com.verisign.epp.codec.fee.v1_0.EPPFeeChkData
All Implemented Interfaces:
EPPCodecComponent, Serializable, Cloneable
public class EPPFeeChkData extends Object implements EPPCodecComponent
The extension to a response to a check command with the fee check extension.
See Also:

  • Field Details

  • Constructor Details

    • EPPFeeChkData

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

    • EPPFeeChkData

      public EPPFeeChkData(String aCurrency)
      EPPFeeChkData constructor that only sets the currency. At least one result must be set.
      Parameters:
      aCurrency - Currency code of fees using a three-character currency code from ISO4217.

    • EPPFeeChkData

      public EPPFeeChkData(String aCurrency, EPPFeeCheckResult aResult)
      EPPFeeChkData constructor that sets a single result.
      Parameters:
      aCurrency - Currency code of fees using a three-character currency code from ISO4217.
      aResult - A single result

    • EPPFeeChkData

      public EPPFeeChkData(String aCurrency, List<EPPFeeCheckResult> aResults)
      EPPFeeChkData constructor that sets a list of results.
      Parameters:
      aCurrency - Currency code of fees using a three-character currency code from ISO4217.
      aResults - List of check results

  • Method Details

    • getNamespace

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

    • getCurrency

      public String getCurrency()
      Gets the currency value.
      Returns:
      Currency if defined; null otherwise.

    • setCurrency

      public void setCurrency(String aCurrency)
      Sets the currency value.
      Parameters:
      aCurrency - Currency value

    • getCheckResults

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

    • setCheckResults

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

    • addCheckResult

      public void addCheckResult(EPPFeeCheckResult aResult)
      Adds a check result to the list of results.
      Parameters:
      aResult - Check result to add to the list.

    • setCheckResult

      public void setCheckResult(EPPFeeCheckResult aResult)
      Sets the result of an individual domain name.
      Parameters:
      aResult - Check result to set

    • encode

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

    • decode

      public void decode(Element aElement) throws EPPDecodeException
      Decode the EPPFeeChkData attributes from the aElement DOM Element tree.
      Specified by:
      decode in interface EPPCodecComponent
      Parameters:
      aElement - Root DOM Element to decode EPPFeeChkData 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.

    • equals

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

    • clone

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