Package com.verisign.epp.codec.balance

Class EPPBalanceInfoResp

java.lang.Object

com.verisign.epp.codec.gen.EPPResponse

com.verisign.epp.codec.balance.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.

Title: EPP 1.0 Balance

Description: Balance Mapping for the EPP SDK

Copyright: Copyright (c) 2011

Company: VeriSign

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ELM_AVAILABLE_CREDIT	The availableCredit XML tag name
static final String	ELM_BALANCE	The balance XML tag name
static final String	ELM_CREDIT_LIMIT	The creditLimit XML tag name
static final String	ELM_NAME	The poll data XML tag name

Fields inherited from class com.verisign.epp.codec.gen.EPPResponse

ELM_EXTENSION, ELM_MESSAGE_QUEUE, ELM_MESSAGE_QUEUE_QDATE, ELM_RESPONSE_DATA, extensions, TRANSFER_CLIENT_APPROVED, TRANSFER_CLIENT_CANCELLED, TRANSFER_CLIENT_REJECTED, TRANSFER_PENDING, TRANSFER_SERVER_APPROVED, TRANSFER_SERVER_CANCELLED

Constructor Summary

Constructors

Constructor	Description
EPPBalanceInfoResp()	Default constructor
EPPBalanceInfoResp(EPPTransId aTransId, BigDecimal aCreditLimit, BigDecimal aBalance, BigDecimal aAvailableCredit, EPPCreditThreshold aCreditThreshold)	EPPBalanceInfoResp that takes all of the required attributes.

Method Summary

Modifier and Type	Method	Description
Object	clone()	Clone EPPLowBalancePollResponse.
void	doDecode(Element aElement)	Populates the data of this instance from the given XML Element which is part of a DOM Document
Element	doEncode(Document aDocument)	Put all data contained in this poll response into the given XML document
boolean	equals(Object aObject)	implements a deep EPPBalanceInfoResp compare.
BigDecimal	getAvailableCredit()	Gets the available credit
BigDecimal	getBalance()	Gets the balance
BigDecimal	getCreditLimit()	Gets the credit limit
EPPCreditThreshold	getCreditThreshold()	Gets the credit threshold
String	getNamespace()	Returns the XML namespace associated with the EPPResponse.
void	setAvailableCredit(BigDecimal aAvailableCredit)	Sets the available credit
void	setBalance(BigDecimal aBalance)	Sets the balance
void	setCreditLimit(BigDecimal aCreditLimit)	Sets the credit Limit
void	setCreditThreshold(EPPCreditThreshold aCreditThreshold)	Sets the credit threshold

Methods inherited from class com.verisign.epp.codec.gen.EPPResponse

addExtension, decode, encode, findDuplicateExtNamespaces, findExtNamespaces, findExtNamespaceSuffixes, findUnsupportedExtNamespaces, findUnsupportedExtNamespaceSuffixes, getExtension, getExtension, getExtensions, getMessageQueue, getMsgQueue, getMsgQueueCount, getMsgQueueDate, getMsgQueueMsg, getQDate, getResult, getResults, getTransId, getType, hasExtension, hasExtensions, hasMessageQueue, hasMsgQueue, hasResultCode, isSuccess, setExtension, setExtensions, setMsgQueue, setResult, setResult, setResult, setResult, setResults, setTransId, toString

Methods inherited from class java.lang.Object

finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

ELM_NAME

public static final String ELM_NAME

The poll data XML tag name

See Also:

• Constant Field Values

ELM_CREDIT_LIMIT

public static final String ELM_CREDIT_LIMIT

The creditLimit XML tag name

See Also:

• Constant Field Values

ELM_BALANCE

public static final String ELM_BALANCE

The balance XML tag name

See Also:

• Constant Field Values

ELM_AVAILABLE_CREDIT

public static final String ELM_AVAILABLE_CREDIT

The availableCredit XML tag name

See Also:

• Constant Field Values

Constructor Details

EPPBalanceInfoResp

public EPPBalanceInfoResp()

Default constructor

EPPBalanceInfoResp

public EPPBalanceInfoResp(EPPTransId aTransId,
 BigDecimal aCreditLimit,
 BigDecimal aBalance,
 BigDecimal aAvailableCredit,
 EPPCreditThreshold aCreditThreshold)

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

aCreditThreshold - Credit threshold to set

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

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

getCreditThreshold

public EPPCreditThreshold getCreditThreshold()

Gets the credit threshold

Returns:

Credit threshold if set; null otherwise.

setCreditThreshold

public void setCreditThreshold(EPPCreditThreshold aCreditThreshold)

Sets the credit threshold

Parameters:

aCreditThreshold - Credit threshold to set