Package com.verisign.epp.codec.balance.v01

Class EPPBalanceInfoResp

java.lang.Object
com.verisign.epp.codec.gen.EPPResponse
com.verisign.epp.codec.balance.v01.EPPBalanceInfoResp
All Implemented Interfaces:
EPPCodecComponent, EPPMessage, Serializable, Cloneable
public class EPPBalanceInfoResp extends EPPResponse
A concrete EPPResponse that knows how to encode/decode Balance Info response from/to XML and object instance.
See Also:

  • Field Details

    • ELM_LOCALNAME

      public static final String ELM_LOCALNAME
      XML local name for EPPFeeCreData.
      See Also:

    • ELM_NAME

      public static final String ELM_NAME
      The poll data XML tag name
      See Also:

    • CURRENCY_DEFAULT

      public static final String CURRENCY_DEFAULT
      Default currency is "USD". The specification doesn't include a default, but adding it to make it easier to transition from the proprietary Balance Mapping.
      See Also:

    • ELM_CREDIT_LIMIT

      public static final String ELM_CREDIT_LIMIT
      The creditLimit XML tag name
      See Also:

    • ELM_BALANCE

      public static final String ELM_BALANCE
      The balance XML tag name
      See Also:

    • ELM_AVAILABLE_CREDIT

      public static final String ELM_AVAILABLE_CREDIT
      The availableCredit XML tag name
      See Also:

    • ELM_CREDIT_THRESHOLD

      public static final String ELM_CREDIT_THRESHOLD
      The creditThreshold XML tag name
      See Also:

  • Constructor Details

    • EPPBalanceInfoResp

      public EPPBalanceInfoResp()
      Default constructor

    • EPPBalanceInfoResp

      public EPPBalanceInfoResp(EPPTransId aTransId, String aCurrency, BigDecimal aCreditLimit, BigDecimal aBalance, BigDecimal aAvailableCredit)
      EPPBalanceInfoResp that takes all of the required attributes.
      Parameters:
      aTransId - Transaction identifier information (server and optional client)
      aCreditLimit - Credit limit to set
      aBalance - Balance to set
      aAvailableCredit - Available credit to set

    • EPPBalanceInfoResp

      public EPPBalanceInfoResp(EPPTransId aTransId, String aCurrency, BigDecimal aCreditLimit, BigDecimal aBalance, BigDecimal aAvailableCredit, BigDecimal aCreditThreshold)
      EPPBalanceInfoResp that takes all of the attributes.
      Parameters:
      aTransId - Transaction identifier information (server and optional client)
      aCreditLimit - Credit limit to set
      aBalance - Balance to set
      aAvailableCredit - Available credit to set
      aCreditThreshold - Credit threshold value

  • Method Details

    • getNamespace

      public String getNamespace()
      Returns the XML namespace associated with the EPPResponse.
      Specified by:
      getNamespace in interface EPPCodecComponent
      Specified by:
      getNamespace in interface EPPMessage
      Overrides:
      getNamespace in class EPPResponse
      Returns:
      XML namespace for the EPPResponse.

    • doEncode

      public Element doEncode(Document aDocument) throws EPPEncodeException
      Put all data contained in this poll response into the given XML document
      Overrides:
      doEncode in class EPPResponse
      Parameters:
      aDocument - the DOM Document to attach data to.
      Returns:
      the element that is a parent of the poll data
      Throws:
      EPPEncodeException - Thrown if any errors occur during the encode process

    • doDecode

      public void doDecode(Element aElement) throws EPPDecodeException
      Populates the data of this instance from the given XML Element which is part of a DOM Document
      Overrides:
      doDecode in class EPPResponse
      Parameters:
      aElement - the element that is a parent of the poll data
      Throws:
      EPPDecodeException - thrown if any errors occur during the decode operation

    • equals

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

    • clone

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

    • hasCurrency

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

    • 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

    • getCreditLimit

      public BigDecimal getCreditLimit()
      Gets the credit limit
      Returns:
      credit limit if set; null otherwise.

    • setCreditLimit

      public void setCreditLimit(BigDecimal aCreditLimit)
      Sets the credit Limit
      Parameters:
      aCreditLimit - Credit limit to set

    • getBalance

      public BigDecimal getBalance()
      Gets the balance
      Returns:
      balance if set; null otherwise.

    • setBalance

      public void setBalance(BigDecimal aBalance)
      Sets the balance
      Parameters:
      aBalance - Balance to set

    • getAvailableCredit

      public BigDecimal getAvailableCredit()
      Gets the available credit
      Returns:
      available credit if set; null otherwise.

    • setAvailableCredit

      public void setAvailableCredit(BigDecimal aAvailableCredit)
      Sets the available credit
      Parameters:
      aAvailableCredit - Available credit to set

    • hasCreditThreshold

      public boolean hasCreditThreshold()
      Is the credit threshold defined?
      Returns:
      true if the credit threshold is defined; false otherwise.

    • getCreditThreshold

      public BigDecimal getCreditThreshold()
      Gets the credit threshold
      Returns:
      Credit threshold if set; null otherwise.

    • setCreditThreshold

      public void setCreditThreshold(BigDecimal aCreditThreshold)
      Sets the credit threshold
      Parameters:
      aCreditThreshold - Credit threshold to set