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 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()
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)
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)
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

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

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)

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)

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)