anon.pay.xml

Class XMLBalance

java.lang.Object

anon.pay.xml.XMLBalance

All Implemented Interfaces:

IXMLEncodable

public class XMLBalance
extends java.lang.Object
implements IXMLEncodable

This class holds a balance certificate. Can be converted to and from XML

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	XMLBalance.MonthlyOverusage

Field Summary

Fields

Modifier and Type	Field and Description
private static java.lang.String	DEFAULT_RATE_ENDDATE
private static java.lang.String	DEFAULT_RATE_STARTDATE
private boolean	m_bBlocked
private double	m_dFactorOverusageGeneral
private double	m_dFactorOverusageUser
private org.w3c.dom.Document	m_docTheBalance
private java.sql.Timestamp	m_flatEnddate
private long	m_lAccountNumber the number of the account that this balance object belongs to
private long	m_lDeposit the amount of money which the user has paid for the corresponding volume plan
private long	m_lLastMonthRemainingTraffic
private long	m_lOverusageBytes
private long	m_lSpent the amount of byte which are already consumed for the corresponding account
private long	m_lVolumeBytesMonthly
private java.lang.String	m_message
private java.net.URL	m_messageLink
private java.lang.String	m_messageText
private java.lang.String	m_strAffiliate
private java.sql.Timestamp	m_Timestamp
private java.sql.Timestamp	m_tMonthlyBytesUpdatedOn
private java.sql.Timestamp	m_tOverusageDate
private Transaction	m_transaction
private java.sql.Timestamp	m_tStartDate
private java.sql.Timestamp	m_ValidTime bytes that are not consumed if there are any will expire after that date
private long	m_volumeBytesleft
private long	m_volumeKBytesleft the kbytes that are still left to spend for the corresponding account

Fields inherited from interface anon.util.IXMLEncodable

FIELD_XML_ELEMENT_CONTAINER_NAME, FIELD_XML_ELEMENT_NAME, XML_ATTR_ID, XML_ATTR_LANGUAGE, XML_ATTR_VERSION

Constructor Summary

Constructors

Constructor and Description
XMLBalance(org.w3c.dom.Document doc)
XMLBalance(org.w3c.dom.Element elemBalance)
XMLBalance(long accountNumber, long deposit, long spent, java.sql.Timestamp timestamp, java.sql.Timestamp validTime, long volumeBytesleft, java.sql.Timestamp flatEnddate, IMyPrivateKey signKey, long a_lVolumeBytesMonthly, java.sql.Timestamp a_tMonthlyBytesUpdatedOn, java.sql.Timestamp a_tStartDate, long a_lOverusageBytes, java.sql.Timestamp a_tOverusageDate, double a_dFactorOverusageGeneral, double a_dFactorOverusageUser, long a_lLastMonthRemainingTraffic, boolean a_bBlocked, java.lang.String a_strAffiliate, Transaction a_transaction)
XMLBalance(java.lang.String xmlDoc)

Method Summary

Modifier and Type	Method and Description
static java.util.Calendar	calculateEndDate(java.util.Calendar a_startDate, int a_duration, int a_calendarFieldUnit)
static java.util.Calendar	calculateEndOfCurrentMonthlyPeriod(java.util.Calendar a_calendarEnd, java.util.Calendar a_calendarNow)
static java.sql.Timestamp	calculateEndOfCurrentMonthlyPeriod(java.sql.Timestamp a_tEnd, java.sql.Timestamp a_tNow)
XMLBalance.MonthlyOverusage	calculateMonthlyOverusage(java.sql.Timestamp a_tNow)
static int	calculateRemainingRateMonths(java.util.Calendar a_calendarEnd, java.util.Calendar a_calendarNow)
static int	calculateRemainingRateMonths(java.sql.Timestamp a_tEnd, java.sql.Timestamp a_tNow)
boolean	canDoMonthlyOverusage(java.sql.Timestamp a_tNow)
long	getAccountNumber() Returns the number the number of the account to which this balance belongs to
java.lang.String	getAffiliate()
long	getDeposit() Returns the total amount of money spent by the user to buy the corresponding volume plan.
java.sql.Timestamp	getFlatEnddate()
long	getLastMonthRemainingTraffic()
PayMessage	getMessage()
java.sql.Timestamp	getMonthlyBytesUpdatedOn()
long	getOverusageBytes()
java.sql.Timestamp	getOverusageDate()
double	getOverusageFactor()
double	getOverusageFactorGeneral()
long	getSpent() Returns the overall spent bytes for the corresponding account
java.sql.Timestamp	getStartDate()
java.sql.Timestamp	getTimestamp()
Transaction	getTransaction() The transaction ID is only set if a transaction has been started (regardless whether it is finished or not).
java.sql.Timestamp	getValidTime() Returns the Date after that unspent byte volume will expire
long	getVolumeBytesLeft() returns the current credit of the user return value will be compared to jap.pay.PaymentMainPanel WARNING_AMOUNT
long	getVolumeBytesMonthly()
private org.w3c.dom.Element	internal_toXmlElement(org.w3c.dom.Document a_doc)
boolean	isBlocked()
boolean	isCurrentlyInOverusage(java.sql.Timestamp a_tNow)
static boolean	isLastMonthOfRate(java.util.Calendar a_calendarEnd, java.util.Calendar a_calendarNow, java.util.Calendar a_calendarStart)
boolean	isLastMonthOfRate(java.sql.Timestamp a_tNow)
static boolean	isLastMonthOfRate(java.sql.Timestamp a_tEnd, java.sql.Timestamp a_tNow, java.sql.Timestamp a_tStart)
private static boolean	isSameMonthlyPeriod(java.util.Calendar calendarUpdatedOn, java.util.Calendar calendarNow, java.util.Calendar calendarStart, boolean a_bUpdatedOnEarlier)
static boolean	isSameMonthlyPeriod(java.sql.Timestamp a_tUpdatedOn, java.sql.Timestamp a_tNow, java.sql.Timestamp a_tStartDate, boolean a_bUpdatedOnEarlier)
void	setMessage(PayMessage a_message)
private void	setValues(org.w3c.dom.Element elemRoot)
void	sign(IMyPrivateKey signKey)
org.w3c.dom.Element	toXmlElement(org.w3c.dom.Document a_doc) Return an element that can be appended to the document.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT_RATE_ENDDATE

private static final java.lang.String DEFAULT_RATE_ENDDATE

See Also:

Constant Field Values

DEFAULT_RATE_STARTDATE

private static final java.lang.String DEFAULT_RATE_STARTDATE

See Also:

Constant Field Values

m_lAccountNumber

private long m_lAccountNumber

the number of the account that this balance object belongs to

m_Timestamp

private java.sql.Timestamp m_Timestamp

m_tStartDate

private java.sql.Timestamp m_tStartDate

m_ValidTime

private java.sql.Timestamp m_ValidTime

bytes that are not consumed if there are any will expire after that date

m_lDeposit

private long m_lDeposit

the amount of money which the user has paid for the corresponding volume plan

m_bBlocked

private boolean m_bBlocked

m_transaction

private Transaction m_transaction

m_lSpent

private long m_lSpent

the amount of byte which are already consumed for the corresponding account

m_lVolumeBytesMonthly

private long m_lVolumeBytesMonthly

m_flatEnddate

private java.sql.Timestamp m_flatEnddate

m_volumeKBytesleft

private long m_volumeKBytesleft

the kbytes that are still left to spend for the corresponding account

m_volumeBytesleft

private long m_volumeBytesleft

m_lOverusageBytes

private long m_lOverusageBytes

m_tOverusageDate

private java.sql.Timestamp m_tOverusageDate

m_dFactorOverusageGeneral

private double m_dFactorOverusageGeneral

m_dFactorOverusageUser

private double m_dFactorOverusageUser

m_message

private java.lang.String m_message

m_messageText

private java.lang.String m_messageText

m_messageLink

private java.net.URL m_messageLink

m_tMonthlyBytesUpdatedOn

private java.sql.Timestamp m_tMonthlyBytesUpdatedOn

m_lLastMonthRemainingTraffic

private long m_lLastMonthRemainingTraffic

m_docTheBalance

private org.w3c.dom.Document m_docTheBalance

m_strAffiliate

private java.lang.String m_strAffiliate

Constructor Detail

XMLBalance

public XMLBalance(long accountNumber,
                  long deposit,
                  long spent,
                  java.sql.Timestamp timestamp,
                  java.sql.Timestamp validTime,
                  long volumeBytesleft,
                  java.sql.Timestamp flatEnddate,
                  IMyPrivateKey signKey,
                  long a_lVolumeBytesMonthly,
                  java.sql.Timestamp a_tMonthlyBytesUpdatedOn,
                  java.sql.Timestamp a_tStartDate,
                  long a_lOverusageBytes,
                  java.sql.Timestamp a_tOverusageDate,
                  double a_dFactorOverusageGeneral,
                  double a_dFactorOverusageUser,
                  long a_lLastMonthRemainingTraffic,
                  boolean a_bBlocked,
                  java.lang.String a_strAffiliate,
                  Transaction a_transaction)

XMLBalance

public XMLBalance(org.w3c.dom.Document doc)
           throws java.lang.Exception

Throws:

java.lang.Exception

XMLBalance

public XMLBalance(java.lang.String xmlDoc)
           throws java.lang.Exception

Throws:

java.lang.Exception

XMLBalance

public XMLBalance(org.w3c.dom.Element elemBalance)
           throws java.lang.Exception

Throws:

java.lang.Exception

Method Detail

sign

public void sign(IMyPrivateKey signKey)

setMessage

public void setMessage(PayMessage a_message)

setValues

private void setValues(org.w3c.dom.Element elemRoot)
                throws java.lang.Exception

Throws:

java.lang.Exception

internal_toXmlElement

private org.w3c.dom.Element internal_toXmlElement(org.w3c.dom.Document a_doc)

getAccountNumber

public long getAccountNumber()

Returns the number the number of the account to which this balance belongs to

Returns:

number of the account that this balance belongs to

getOverusageFactorGeneral

public double getOverusageFactorGeneral()

getOverusageFactor

public double getOverusageFactor()

getAffiliate

public java.lang.String getAffiliate()

isBlocked

public boolean isBlocked()

getDeposit

public long getDeposit()

Returns the total amount of money spent by the user to buy the corresponding volume plan.

Returns:

costs for the volume plan of the corresponding account

getTransaction

public Transaction getTransaction()

The transaction ID is only set if a transaction has been started (regardless whether it is finished or not).

Returns:

getSpent

public long getSpent()

Returns the overall spent bytes for the corresponding account

Returns:

bytes spent overall

getOverusageBytes

public long getOverusageBytes()

getOverusageDate

public java.sql.Timestamp getOverusageDate()

getMonthlyBytesUpdatedOn

public java.sql.Timestamp getMonthlyBytesUpdatedOn()

getVolumeBytesMonthly

public long getVolumeBytesMonthly()

getLastMonthRemainingTraffic

public long getLastMonthRemainingTraffic()

getVolumeBytesLeft

public long getVolumeBytesLeft()

returns the current credit of the user return value will be compared to jap.pay.PaymentMainPanel WARNING_AMOUNT

Returns:

long: currently volume_bytesleft

getStartDate

public java.sql.Timestamp getStartDate()

getFlatEnddate

public java.sql.Timestamp getFlatEnddate()

getTimestamp

public java.sql.Timestamp getTimestamp()

getValidTime

public java.sql.Timestamp getValidTime()

Returns the Date after that unspent byte volume will expire

Returns:

the expire date

getMessage

public PayMessage getMessage()

Returns:

PayMessage: a PayMessage object if this Balance has a message associated with it If the short message text is null or an empty String, getMessage() will return null (even if a link or long text exists)

calculateMonthlyOverusage

public XMLBalance.MonthlyOverusage calculateMonthlyOverusage(java.sql.Timestamp a_tNow)

toXmlElement

public org.w3c.dom.Element toXmlElement(org.w3c.dom.Document a_doc)

Description copied from interface: IXMLEncodable

Return an element that can be appended to the document. This Method must not change the document in any way!

Specified by:

toXmlElement in interface IXMLEncodable

Parameters:

a_doc - a document

Returns:

the interface as xml element

isCurrentlyInOverusage

public boolean isCurrentlyInOverusage(java.sql.Timestamp a_tNow)

canDoMonthlyOverusage

public boolean canDoMonthlyOverusage(java.sql.Timestamp a_tNow)

isSameMonthlyPeriod

public static boolean isSameMonthlyPeriod(java.sql.Timestamp a_tUpdatedOn,
                                          java.sql.Timestamp a_tNow,
                                          java.sql.Timestamp a_tStartDate,
                                          boolean a_bUpdatedOnEarlier)

isSameMonthlyPeriod

private static boolean isSameMonthlyPeriod(java.util.Calendar calendarUpdatedOn,
                                           java.util.Calendar calendarNow,
                                           java.util.Calendar calendarStart,
                                           boolean a_bUpdatedOnEarlier)

calculateRemainingRateMonths

public static int calculateRemainingRateMonths(java.util.Calendar a_calendarEnd,
                                               java.util.Calendar a_calendarNow)

calculateEndOfCurrentMonthlyPeriod

public static java.sql.Timestamp calculateEndOfCurrentMonthlyPeriod(java.sql.Timestamp a_tEnd,
                                                                    java.sql.Timestamp a_tNow)

calculateEndOfCurrentMonthlyPeriod

public static java.util.Calendar calculateEndOfCurrentMonthlyPeriod(java.util.Calendar a_calendarEnd,
                                                                    java.util.Calendar a_calendarNow)

calculateRemainingRateMonths

public static int calculateRemainingRateMonths(java.sql.Timestamp a_tEnd,
                                               java.sql.Timestamp a_tNow)

calculateEndDate

public static java.util.Calendar calculateEndDate(java.util.Calendar a_startDate,
                                                  int a_duration,
                                                  int a_calendarFieldUnit)

isLastMonthOfRate

public boolean isLastMonthOfRate(java.sql.Timestamp a_tNow)

isLastMonthOfRate

public static boolean isLastMonthOfRate(java.sql.Timestamp a_tEnd,
                                        java.sql.Timestamp a_tNow,
                                        java.sql.Timestamp a_tStart)

isLastMonthOfRate

public static boolean isLastMonthOfRate(java.util.Calendar a_calendarEnd,
                                        java.util.Calendar a_calendarNow,
                                        java.util.Calendar a_calendarStart)