com.konakart.app
Class IpnHistory

java.lang.Object
  com.konakart.app.IpnHistory

All Implemented Interfaces:

IpnHistoryIf

public class IpnHistory
extends java.lang.Object
implements IpnHistoryIf

Contains the data received from an instant product notification from a payment gateway.

Constructor Summary

IpnHistory()
Constructor

IpnHistory(com.workingdogs.village.Record vr, org.apache.torque.util.Criteria c)
Instantiates the attributes of the Country object from a Record object

Method Summary

java.lang.String	getCustom1()
java.math.BigDecimal	getCustom1Dec()
java.lang.String	getCustom2()
java.math.BigDecimal	getCustom2Dec()
java.lang.String	getCustom3()
java.lang.String	getCustom4()
int	getCustomerId()
java.util.Calendar	getDateAdded()
java.lang.String	getGatewayFullResponse() The full response received by the payment gateway.
java.lang.String	getGatewayResult() The result string returned by the payment gateway (i.e.
java.lang.String	getGatewayTransactionId() The transaction id returned by the payment gateway
int	getId() Id
java.lang.String	getKonakartResultDescription() A description of the KonaKart result.
int	getKonakartResultId() A KonaKart result.
java.lang.String	getModuleCode() The code of the payment module (i.e.
int	getOrderId() The order id for the payment
int	getSubscriptionId() The id of the subscription object if this payment is part of a recurring billing scenario
java.math.BigDecimal	getTxAmount() The amount of the transaction.
java.lang.String	getTxType() The type of transaction.
void	setCustom1(java.lang.String custom1)
void	setCustom1Dec(java.math.BigDecimal custom1Dec)
void	setCustom2(java.lang.String custom2)
void	setCustom2Dec(java.math.BigDecimal custom2Dec)
void	setCustom3(java.lang.String custom3)
void	setCustom4(java.lang.String custom4)
void	setCustomerId(int customerId)
void	setDateAdded(java.util.Calendar dateAdded)
void	setGatewayFullResponse(java.lang.String gatewayFullResponse) The full response received by the payment gateway.
void	setGatewayResult(java.lang.String gatewayResult) The result string returned by the payment gateway (i.e.
void	setGatewayTransactionId(java.lang.String gatewayTransactionId) The transaction id returned by the payment gateway
void	setId(int id) Id
void	setKonakartResultDescription(java.lang.String konakartResultDescription) A description of the KonaKart result.
void	setKonakartResultId(int konakartResultId) A KonaKart result.
void	setModuleCode(java.lang.String moduleCode) The code of the payment module (i.e.
void	setOrderId(int orderId) The order id for the payment
void	setSubscriptionId(int subscriptionId) The id of the subscription object if this payment is part of a recurring billing scenario
void	setTxAmount(java.math.BigDecimal txAmount) The amount of the transaction.
void	setTxType(java.lang.String txType) The type of transaction.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

IpnHistory

public IpnHistory()

Constructor

IpnHistory

public IpnHistory(com.workingdogs.village.Record vr,
                  org.apache.torque.util.Criteria c)
           throws com.workingdogs.village.DataSetException

Instantiates the attributes of the Country object from a Record object

Parameters:

vr - Record containing data

c - Criteria containing column names

Throws:

com.workingdogs.village.DataSetException

Method Detail

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

Returns:

Returns a string containing the attributes of the Country object.

getGatewayFullResponse

public java.lang.String getGatewayFullResponse()

Description copied from interface: IpnHistoryIf

The full response received by the payment gateway. Format is normally paramName1=paramValue1¶mName2=paramValue2& etc.)

Specified by:

getGatewayFullResponse in interface IpnHistoryIf

Returns:

Return the GatewayFullResponse

setGatewayFullResponse

public void setGatewayFullResponse(java.lang.String gatewayFullResponse)

Description copied from interface: IpnHistoryIf

The full response received by the payment gateway. Format is paramName1=paramValue1¶mName2=paramValue2& etc.)

Specified by:

setGatewayFullResponse in interface IpnHistoryIf

getGatewayResult

public java.lang.String getGatewayResult()

Description copied from interface: IpnHistoryIf

The result string returned by the payment gateway (i.e. approved or declined)

Specified by:

getGatewayResult in interface IpnHistoryIf

Returns:

Return the GatewayResult

setGatewayResult

public void setGatewayResult(java.lang.String gatewayResult)

Description copied from interface: IpnHistoryIf

The result string returned by the payment gateway (i.e. approved or declined)

Specified by:

setGatewayResult in interface IpnHistoryIf

getGatewayTransactionId

public java.lang.String getGatewayTransactionId()

Description copied from interface: IpnHistoryIf

The transaction id returned by the payment gateway

Specified by:

getGatewayTransactionId in interface IpnHistoryIf

Returns:

Return the GatewayTransactionId

setGatewayTransactionId

public void setGatewayTransactionId(java.lang.String gatewayTransactionId)

Description copied from interface: IpnHistoryIf

The transaction id returned by the payment gateway

Specified by:

setGatewayTransactionId in interface IpnHistoryIf

getId

public int getId()

Description copied from interface: IpnHistoryIf

Id

Specified by:

getId in interface IpnHistoryIf

Returns:

Return the Id

setId

public void setId(int id)

Description copied from interface: IpnHistoryIf

Id

Specified by:

setId in interface IpnHistoryIf

getKonakartResultDescription

public java.lang.String getKonakartResultDescription()

Description copied from interface: IpnHistoryIf

A description of the KonaKart result. The KonaKart results determines whether the transaction was successful even though payment authorisation may have been declined.

Specified by:

getKonakartResultDescription in interface IpnHistoryIf

Returns:

Return the KonakartResultDescription

setKonakartResultDescription

public void setKonakartResultDescription(java.lang.String konakartResultDescription)

Description copied from interface: IpnHistoryIf

A description of the KonaKart result. The KonaKart results determines whether the transaction was successful even though payment authorisation may have been declined.

Specified by:

setKonakartResultDescription in interface IpnHistoryIf

getKonakartResultId

public int getKonakartResultId()

Description copied from interface: IpnHistoryIf

A KonaKart result. Set to zero if all is OK. A negative number if something has gone wrong. i.e. We may not be able to associate a callback with an order.

Specified by:

getKonakartResultId in interface IpnHistoryIf

Returns:

Return the KonakartResultId

setKonakartResultId

public void setKonakartResultId(int konakartResultId)

Description copied from interface: IpnHistoryIf

A KonaKart result. Set to zero if all is OK. A negative number if something has gone wrong. i.e. We may not be able to associate a callback with an order.

Specified by:

setKonakartResultId in interface IpnHistoryIf

getModuleCode

public java.lang.String getModuleCode()

Description copied from interface: IpnHistoryIf

The code of the payment module (i.e. paypal, chronopay etc.

Specified by:

getModuleCode in interface IpnHistoryIf

Returns:

Return the ModuleCode

setModuleCode

public void setModuleCode(java.lang.String moduleCode)

Description copied from interface: IpnHistoryIf

The code of the payment module (i.e. paypal, chronopay etc.

Specified by:

setModuleCode in interface IpnHistoryIf

getOrderId

public int getOrderId()

Description copied from interface: IpnHistoryIf

The order id for the payment

Specified by:

getOrderId in interface IpnHistoryIf

Returns:

Return the OrderId

setOrderId

public void setOrderId(int orderId)

Description copied from interface: IpnHistoryIf

The order id for the payment

Specified by:

setOrderId in interface IpnHistoryIf

getDateAdded

public java.util.Calendar getDateAdded()

Specified by:

getDateAdded in interface IpnHistoryIf

Returns:

Returns the dateAdded.

setDateAdded

public void setDateAdded(java.util.Calendar dateAdded)

Specified by:

setDateAdded in interface IpnHistoryIf

Parameters:

dateAdded - The dateAdded to set.

getCustomerId

public int getCustomerId()

Specified by:

getCustomerId in interface IpnHistoryIf

Returns:

Returns the customerId.

setCustomerId

public void setCustomerId(int customerId)

Specified by:

setCustomerId in interface IpnHistoryIf

Parameters:

customerId - The customerId to set.

getTxAmount

public java.math.BigDecimal getTxAmount()

The amount of the transaction. Useful in cases where it may be different to the amount of the order.

Specified by:

getTxAmount in interface IpnHistoryIf

Returns:

the txAmount

setTxAmount

public void setTxAmount(java.math.BigDecimal txAmount)

The amount of the transaction. Useful in cases where it may be different to the amount of the order.

Specified by:

setTxAmount in interface IpnHistoryIf

Parameters:

txAmount - the txAmount to set

getTxType

public java.lang.String getTxType()

The type of transaction. i.e. Authorization or Capture

Specified by:

getTxType in interface IpnHistoryIf

Returns:

the txType

setTxType

public void setTxType(java.lang.String txType)

The type of transaction. i.e. Authorization or Capture

Specified by:

setTxType in interface IpnHistoryIf

Parameters:

txType - the txType to set

getCustom1

public java.lang.String getCustom1()

Specified by:

getCustom1 in interface IpnHistoryIf

Returns:

the custom1

setCustom1

public void setCustom1(java.lang.String custom1)

Specified by:

setCustom1 in interface IpnHistoryIf

Parameters:

custom1 - the custom1 to set

getCustom2

public java.lang.String getCustom2()

Specified by:

getCustom2 in interface IpnHistoryIf

Returns:

the custom2

setCustom2

public void setCustom2(java.lang.String custom2)

Specified by:

setCustom2 in interface IpnHistoryIf

Parameters:

custom2 - the custom2 to set

getCustom3

public java.lang.String getCustom3()

Specified by:

getCustom3 in interface IpnHistoryIf

Returns:

the custom3

setCustom3

public void setCustom3(java.lang.String custom3)

Specified by:

setCustom3 in interface IpnHistoryIf

Parameters:

custom3 - the custom3 to set

getCustom4

public java.lang.String getCustom4()

Specified by:

getCustom4 in interface IpnHistoryIf

Returns:

the custom4

setCustom4

public void setCustom4(java.lang.String custom4)

Specified by:

setCustom4 in interface IpnHistoryIf

Parameters:

custom4 - the custom4 to set

getCustom1Dec

public java.math.BigDecimal getCustom1Dec()

Specified by:

getCustom1Dec in interface IpnHistoryIf

Returns:

the custom1Dec

setCustom1Dec

public void setCustom1Dec(java.math.BigDecimal custom1Dec)

Specified by:

setCustom1Dec in interface IpnHistoryIf

Parameters:

custom1Dec - the custom1Dec to set

getCustom2Dec

public java.math.BigDecimal getCustom2Dec()

Specified by:

getCustom2Dec in interface IpnHistoryIf

Returns:

the custom2Dec

setCustom2Dec

public void setCustom2Dec(java.math.BigDecimal custom2Dec)

Specified by:

setCustom2Dec in interface IpnHistoryIf

Parameters:

custom2Dec - the custom2Dec to set

getSubscriptionId

public int getSubscriptionId()

The id of the subscription object if this payment is part of a recurring billing scenario

Specified by:

getSubscriptionId in interface IpnHistoryIf

Returns:

the subscriptionId

setSubscriptionId

public void setSubscriptionId(int subscriptionId)

The id of the subscription object if this payment is part of a recurring billing scenario

Specified by:

setSubscriptionId in interface IpnHistoryIf

Parameters:

subscriptionId - the subscriptionId to set