AdminIpnHistory (KonaKartAdmin API Documentation)

java.lang.Object
- com.konakartadmin.app.AdminIpnHistory

```
public class AdminIpnHistory
extends java.lang.Object
```
Contains the data received from an instant product notification from a payment gateway. The data normally contains information about the outcome of a payment attempt.

Field Summary

Fields
Modifier and Type	Field and Description
`private java.lang.String`	`adminPaymentClass` The class that can be used to make further transactions later such as a capture or a credit
`private java.lang.String`	`custom1` Custom fields
`private java.math.BigDecimal`	`custom1Dec`
`private java.lang.String`	`custom2`
`private java.math.BigDecimal`	`custom2Dec`
`private java.lang.String`	`custom3`
`private java.lang.String`	`custom4`
`private int`	`customerId` The customer id of the person making the payment
`private java.util.Date`	`dateAdded` dateAdded
`private java.lang.String`	`gatewayCaptureId` The id that may be used to perform a capture operation
`private java.lang.String`	`gatewayCreditId` The id that may be used to refund a customer
`private java.lang.String`	`gatewayFullResponse` The full response received by the payment gateway.
`private java.lang.String`	`gatewayResult` The result string returned by the payment gateway (i.e.
`private java.lang.String`	`gatewayTransactionId` The transaction id returned by the payment gateway
`private int`	`id` Id
`private java.lang.String`	`konakartResultDescription` A description of the KonaKart result
`private int`	`konakartResultId` A KonaKart result.
`private java.lang.String`	`moduleCode` The code of the payment module (i.e.
`private int`	`orderId` The order id for the payment
`private int`	`subscriptionId` The id of the subscription object if this payment is part of a recurring billing scenario
`private java.math.BigDecimal`	`txAmount` The amount of the transaction.
`private java.lang.String`	`txType` The type of transaction.

Constructor Summary

Constructors
Constructor and Description
`AdminIpnHistory()` Constructor
`AdminIpnHistory(com.workingdogs.village.Record vr, com.konakart.db.KKCriteria c)` Instantiates the attributes of the Country object from a Record object

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.String`	`getAdminPaymentClass()` The class that can be used to make further transactions later such as a capture or a credit
`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.Date`	`getDateAdded()`
`java.lang.String`	`getGatewayCaptureId()` The id that may be used to perform a capture operation
`java.lang.String`	`getGatewayCreditId()` The id that may be used to refund a customer
`java.lang.String`	`getGatewayFullResponse()`
`java.lang.String`	`getGatewayResult()`
`java.lang.String`	`getGatewayTransactionId()`
`int`	`getId()`
`java.lang.String`	`getKonakartResultDescription()`
`int`	`getKonakartResultId()`
`java.lang.String`	`getModuleCode()`
`int`	`getOrderId()`
`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`	`setAdminPaymentClass(java.lang.String adminPaymentClass)` The class that can be used to make further transactions later such as a capture or a credit
`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.Date dateAdded)`
`void`	`setGatewayCaptureId(java.lang.String gatewayCaptureId)` The id that may be used to perform a capture operation
`void`	`setGatewayCreditId(java.lang.String gatewayCreditId)` The id that may be used to refund a customer
`void`	`setGatewayFullResponse(java.lang.String gatewayFullResponse)`
`void`	`setGatewayResult(java.lang.String gatewayResult)`
`void`	`setGatewayTransactionId(java.lang.String gatewayTransactionId)`
`void`	`setId(int id)`
`void`	`setKonakartResultDescription(java.lang.String konakartResultDescription)`
`void`	`setKonakartResultId(int konakartResultId)`
`void`	`setModuleCode(java.lang.String moduleCode)`
`void`	`setOrderId(int orderId)`
`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

- Field Detail
  - id
```
private int id
```
    Id
  - dateAdded
```
private java.util.Date dateAdded
```
    dateAdded
  - moduleCode
```
private java.lang.String moduleCode
```
    The code of the payment module (i.e. paypal, chronopay etc.
  - gatewayTransactionId
```
private java.lang.String gatewayTransactionId
```
    The transaction id returned by the payment gateway
  - gatewayCaptureId
```
private java.lang.String gatewayCaptureId
```
    The id that may be used to perform a capture operation
  - gatewayCreditId
```
private java.lang.String gatewayCreditId
```
    The id that may be used to refund a customer
  - gatewayResult
```
private java.lang.String gatewayResult
```
    The result string returned by the payment gateway (i.e. approved or declined)
  - gatewayFullResponse
```
private java.lang.String gatewayFullResponse
```
    The full response received by the payment gateway. Format is:
```
 
 paramName1=paramValue1&paramName2=paramValue2& etc.)
 
 
```
  - orderId
```
private int orderId
```
    The order id for the payment
  - konakartResultId
```
private int konakartResultId
```
    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.
  - konakartResultDescription
```
private java.lang.String konakartResultDescription
```
    A description of the KonaKart result
  - customerId
```
private int customerId
```
    The customer id of the person making the payment
  - subscriptionId
```
private int subscriptionId
```
    The id of the subscription object if this payment is part of a recurring billing scenario
  - txAmount
```
private java.math.BigDecimal txAmount
```
    The amount of the transaction. Useful in cases where it may be different to the amount of the order.
  - txType
```
private java.lang.String txType
```
    The type of transaction. i.e. Authorization or Capture
  - adminPaymentClass
```
private java.lang.String adminPaymentClass
```
    The class that can be used to make further transactions later such as a capture or a credit
  - custom1
```
private java.lang.String custom1
```
    Custom fields
  - custom2
```
private java.lang.String custom2
```
  - custom3
```
private java.lang.String custom3
```
  - custom4
```
private java.lang.String custom4
```
  - custom1Dec
```
private java.math.BigDecimal custom1Dec
```
  - custom2Dec
```
private java.math.BigDecimal custom2Dec
```
- Constructor Detail
  - AdminIpnHistory
```
public AdminIpnHistory()
```
    Constructor
  - AdminIpnHistory
```
public AdminIpnHistory(com.workingdogs.village.Record vr,
                       com.konakart.db.KKCriteria 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 - an unexpected exception due to data in Torque (the database layer)
- 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()
```
    Returns:
    
    gatewayFullResponse
  - setGatewayFullResponse
```
public void setGatewayFullResponse(java.lang.String gatewayFullResponse)
```
    Parameters:
    
    gatewayFullResponse - the gatewayFullResponse
  - getGatewayResult
```
public java.lang.String getGatewayResult()
```
    Returns:
    
    gatewayResult
  - setGatewayResult
```
public void setGatewayResult(java.lang.String gatewayResult)
```
    Parameters:
    
    gatewayResult - the gatewayResult
  - getGatewayTransactionId
```
public java.lang.String getGatewayTransactionId()
```
    Returns:
    
    gatewayTransactionId
  - setGatewayTransactionId
```
public void setGatewayTransactionId(java.lang.String gatewayTransactionId)
```
    Parameters:
    
    gatewayTransactionId - the gatewayTransactionId
  - getGatewayCaptureId
```
public java.lang.String getGatewayCaptureId()
```
    The id that may be used to perform a capture operation
    
    Returns:
    
    the gatewayCaptureId
  - setGatewayCaptureId
```
public void setGatewayCaptureId(java.lang.String gatewayCaptureId)
```
    The id that may be used to perform a capture operation
    
    Parameters:
    
    gatewayCaptureId - the gatewayCaptureId to set
  - getGatewayCreditId
```
public java.lang.String getGatewayCreditId()
```
    The id that may be used to refund a customer
    
    Returns:
    
    the gatewayCreditId
  - setGatewayCreditId
```
public void setGatewayCreditId(java.lang.String gatewayCreditId)
```
    The id that may be used to refund a customer
    
    Parameters:
    
    gatewayCreditId - the gatewayCreditId to set
  - getId
```
public int getId()
```
    Returns:
    
    the id
  - setId
```
public void setId(int id)
```
    Parameters:
    
    id - the id to set
  - getKonakartResultDescription
```
public java.lang.String getKonakartResultDescription()
```
    Returns:
    
    konakartResultDescription
  - setKonakartResultDescription
```
public void setKonakartResultDescription(java.lang.String konakartResultDescription)
```
    Parameters:
    
    konakartResultDescription - the konakartResultDescription
  - getKonakartResultId
```
public int getKonakartResultId()
```
    Returns:
    
    konakartResultId
  - setKonakartResultId
```
public void setKonakartResultId(int konakartResultId)
```
    Parameters:
    
    konakartResultId - the konakartResultId
  - getModuleCode
```
public java.lang.String getModuleCode()
```
    Returns:
    
    moduleCode
  - setModuleCode
```
public void setModuleCode(java.lang.String moduleCode)
```
    Parameters:
    
    moduleCode - the moduleCode
  - getOrderId
```
public int getOrderId()
```
    Returns:
    
    orderId
  - setOrderId
```
public void setOrderId(int orderId)
```
    Parameters:
    
    orderId - the orderId
  - getDateAdded
```
public java.util.Date getDateAdded()
```
    Returns:
    
    Returns the dateAdded.
  - setDateAdded
```
public void setDateAdded(java.util.Date dateAdded)
```
    Parameters:
    
    dateAdded - The dateAdded to set.
  - getCustomerId
```
public int getCustomerId()
```
    Returns:
    
    the customerId
  - setCustomerId
```
public void setCustomerId(int customerId)
```
    Parameters:
    
    customerId - the customerId to set
  - getSubscriptionId
```
public int getSubscriptionId()
```
    The id of the subscription object if this payment is part of a recurring billing scenario
    
    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
    
    Parameters:
    
    subscriptionId - the subscriptionId 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.
    
    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.
    
    Parameters:
    
    txAmount - the txAmount to set
  - getTxType
```
public java.lang.String getTxType()
```
    The type of transaction. i.e. Authorization or Capture
    
    Returns:
    
    the txType
  - setTxType
```
public void setTxType(java.lang.String txType)
```
    The type of transaction. i.e. Authorization or Capture
    
    Parameters:
    
    txType - the txType to set
  - getCustom1
```
public java.lang.String getCustom1()
```
    Returns:
    
    the custom1
  - setCustom1
```
public void setCustom1(java.lang.String custom1)
```
    Parameters:
    
    custom1 - the custom1 to set
  - getCustom2
```
public java.lang.String getCustom2()
```
    Returns:
    
    the custom2
  - setCustom2
```
public void setCustom2(java.lang.String custom2)
```
    Parameters:
    
    custom2 - the custom2 to set
  - getCustom3
```
public java.lang.String getCustom3()
```
    Returns:
    
    the custom3
  - setCustom3
```
public void setCustom3(java.lang.String custom3)
```
    Parameters:
    
    custom3 - the custom3 to set
  - getCustom4
```
public java.lang.String getCustom4()
```
    Returns:
    
    the custom4
  - setCustom4
```
public void setCustom4(java.lang.String custom4)
```
    Parameters:
    
    custom4 - the custom4 to set
  - getCustom1Dec
```
public java.math.BigDecimal getCustom1Dec()
```
    Returns:
    
    the custom1Dec
  - setCustom1Dec
```
public void setCustom1Dec(java.math.BigDecimal custom1Dec)
```
    Parameters:
    
    custom1Dec - the custom1Dec to set
  - getCustom2Dec
```
public java.math.BigDecimal getCustom2Dec()
```
    Returns:
    
    the custom2Dec
  - setCustom2Dec
```
public void setCustom2Dec(java.math.BigDecimal custom2Dec)
```
    Parameters:
    
    custom2Dec - the custom2Dec to set
  - getAdminPaymentClass
```
public java.lang.String getAdminPaymentClass()
```
    The class that can be used to make further transactions later such as a capture or a credit
    
    Returns:
    
    the adminPaymentClass
  - setAdminPaymentClass
```
public void setAdminPaymentClass(java.lang.String adminPaymentClass)
```
    The class that can be used to make further transactions later such as a capture or a credit
    
    Parameters:
    
    adminPaymentClass - the adminPaymentClass to set

Class AdminIpnHistory

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

id

dateAdded

moduleCode

gatewayTransactionId

gatewayCaptureId

gatewayCreditId

gatewayResult

gatewayFullResponse

orderId

konakartResultId

konakartResultDescription

customerId

subscriptionId

txAmount

txType

adminPaymentClass

custom1

custom2

custom3

custom4

custom1Dec

custom2Dec

Constructor Detail

AdminIpnHistory

AdminIpnHistory

Method Detail

toString

getGatewayFullResponse

setGatewayFullResponse

getGatewayResult

setGatewayResult

getGatewayTransactionId

setGatewayTransactionId

getGatewayCaptureId

setGatewayCaptureId

getGatewayCreditId

setGatewayCreditId

getId

setId

getKonakartResultDescription

setKonakartResultDescription

getKonakartResultId

setKonakartResultId

getModuleCode

setModuleCode

getOrderId

setOrderId

getDateAdded

setDateAdded

getCustomerId

setCustomerId

getSubscriptionId

setSubscriptionId

getTxAmount

setTxAmount

getTxType

setTxType

getCustom1

setCustom1

getCustom2

setCustom2

getCustom3

setCustom3

getCustom4

setCustom4

getCustom1Dec

setCustom1Dec

getCustom2Dec

setCustom2Dec

getAdminPaymentClass

setAdminPaymentClass