Transaction (stumps 1.0-SNAPSHOT API)

java.lang.Object
- com.neurosys.domain.ModelObject
- - com.neurosys.domain.DomainObject
  - - com.neurosys.ecom.orders.domain.Transaction<O>

Type Parameters:

O - as Order type

All Implemented Interfaces:

Auditable, Serializable
```
@Entity
public class Transaction<O extends Order>
extends DomainObject
implements Auditable
```
Represents an Online Transaction done via a Gateway or mediator; with a possible Issuer source. The issuer is an entity/service that does the actual debt/credit like a Bank or provider.

If the Issuer is the same as the Gateway data maybe duplicated OR one may put the data in the gateway specific columns as preference and assume the same for issuer. Issuer data is supplement to Gateway.

Author:

Arjun Dhar

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

static String TIME_ZONE

Fields
Modifier and Type	Field and Description
`static String`	`TIME_ZONE`

Constructor Summary

Constructors
Constructor and Description
`Transaction()`
`Transaction(String id, O order, String gatewayId)`
`Transaction(String id, O order, String gatewayId, String gatewayTransactionId, boolean success)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getActualDateTime()` Date time the transaction was conducted The String format is used to preserve in format as sent by gateway
`TransactionAmount`	`getAmount()` Transaction amount We want to maintain the details @ the transaction level in addition to `Order` because Orders may be modified. We can tract at the point in time, what was the exact amount transacted.
`Date`	`getDateTime()` When the system got the response and recorded it Should be set as soon as the Transaction flow returns control to the API that called the transaction and gets the Response Code.
`String`	`getFailureGatewayResponse()` Specific reason for gateway Failure
`String`	`getFailureIssuerResponse()` Specific reason for issuer Failure
`TransactionAmount`	`getFee()` An optional transaction fee
`String`	`getGatewayId()` Identify the Gateway / Broker
`String`	`getGatewayRequestParams()` When being redirected to gateway/Service; capture the URL param details
`String`	`getGatewayResponseJSON()` Capture any other flags and attributes from the gateway in a JSON String
`String`	`getGatewayResultCode()` A response/Result mnemonic from the gateway indicating the final result of the Transaction
`String`	`getGatewayTransactionId()` A unique transaction Id generated by the gateway This maybe the same as `id`.
`String`	`getId()` Transaction Id : Typically generated as a combination of
`String`	`getIssuerResultCode()` A response/Result mnemonic from the Issuer indicating the final result of the Transaction
`String`	`getIssuerTransactionId()` If multiple parties are involved, then the gateway maybe an intermediate party.
`O`	`getOrder()`
`String`	`getResultDesc()` Result Description if any provided by the gateway to supplement the `#resultCode`
`Boolean`	`getSuccess()` Was the transaction successful or Not Note: A Transaction may have two aspects.
`String`	`getType()` Transaction type details/code
`void`	`setActualDateTime(String actualDateTime)` Date time the transaction was conducted The String format is used to preserve in format as sent by gateway
`void`	`setAmount(TransactionAmount amount)` Transaction amount We want to maintain the details @ the transaction level in addition to `Order` because Orders may be modified. We can tract at the point in time, what was the exact amount transacted.
`void`	`setDateTime(Date dateTime)` When the system got the response and recorded it Should be set as soon as the Transaction flow returns control to the API that called the transaction and gets the Response Code.
`void`	`setFailureGatewayResponse(String failureGatewayResponse)` Specific reason for gateway Failure
`void`	`setFailureIssuerResponse(String failureIssuerResponse)` Specific reason for issuer Failure
`void`	`setFee(TransactionAmount fee)` An optional transaction fee
`void`	`setGatewayId(String gatewayId)` Identify the Gateway / Broker
`void`	`setGatewayRequestParams(String gatewayRequestParams)` When being redirected to gateway/Service; capture the URL param details
`void`	`setGatewayResponseJSON(String gatewayResponseJSON)` Capture any other flags and attributes from the gateway in a JSON String
`void`	`setGatewayResultCode(String gatewayResultCode)` A response/Result mnemonic from the gateway indicating the final result of the Transaction
`void`	`setGatewayTransactionId(String gatewayTransactionId)` A unique transaction Id generated by the gateway This maybe the same as `id`.
`void`	`setId(String id)` Transaction Id : Typically generated as a combination of
`void`	`setIssuerResultCode(String issuerResultCode)` A response/Result mnemonic from the Issuer indicating the final result of the Transaction
`void`	`setIssuerTransactionId(String issuerTransactionId)` If multiple parties are involved, then the gateway maybe an intermediate party.
`void`	`setOrder(O order)`
`void`	`setResultDesc(String resultDesc)` Result Description if any provided by the gateway to supplement the `#resultCode`
`void`	`setSuccess(Boolean success)` Was the transaction successful or Not Note: A Transaction may have two aspects.
`void`	`setType(String type)` Transaction type details/code
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - TIME_ZONE
```
public static final String TIME_ZONE
```
- Constructor Detail
  - Transaction
```
public Transaction()
```
  - Transaction
```
public Transaction(String id,
                   O order,
                   String gatewayId,
                   String gatewayTransactionId,
                   boolean success)
```
    Parameters:
    
    id - as unique transaction Id
    
    order - as Order type
    
    gatewayTxnId - as String
    
    gatewayTransactionId - as String (unique id provided by the gateway)
    
    success - as boolean
  - Transaction
```
public Transaction(String id,
                   O order,
                   String gatewayId)
```
    Parameters:
    
    id - as unique transaction Id
    
    order - as Order type
    
    gatewayId - as String
- Method Detail
  - getId
```
public String getId()
```
    Transaction Id : Typically generated as a combination of
  - setId
```
public void setId(String id)
```
    Transaction Id : Typically generated as a combination of
  - getGatewayTransactionId
```
public String getGatewayTransactionId()
```
    A unique transaction Id generated by the gateway
    This maybe the same as id. The subtle difference is that this is generated by the gateway and the id is assigned by the calling API.
    
    Can be null:
    
    true, if it never got back from the Gateway
  - setGatewayTransactionId
```
public void setGatewayTransactionId(String gatewayTransactionId)
```
    A unique transaction Id generated by the gateway
    This maybe the same as id. The subtle difference is that this is generated by the gateway and the id is assigned by the calling API.
    
    Can be null:
    
    true, if it never got back from the Gateway
  - getIssuerTransactionId
```
public String getIssuerTransactionId()
```
    If multiple parties are involved, then the gateway maybe an intermediate party. In that case we may also want the reference/transaction id from the issuing/credit/debt service provider/bank.
  - setIssuerTransactionId
```
public void setIssuerTransactionId(String issuerTransactionId)
```
    If multiple parties are involved, then the gateway maybe an intermediate party. In that case we may also want the reference/transaction id from the issuing/credit/debt service provider/bank.
  - getOrder
```
public O getOrder()
```
  - setOrder
```
public void setOrder(O order)
```
  - getGatewayResultCode
```
public String getGatewayResultCode()
```
    A response/Result mnemonic from the gateway indicating the final result of the Transaction
  - setGatewayResultCode
```
public void setGatewayResultCode(String gatewayResultCode)
```
    A response/Result mnemonic from the gateway indicating the final result of the Transaction
  - getIssuerResultCode
```
public String getIssuerResultCode()
```
    A response/Result mnemonic from the Issuer indicating the final result of the Transaction
  - setIssuerResultCode
```
public void setIssuerResultCode(String issuerResultCode)
```
    A response/Result mnemonic from the Issuer indicating the final result of the Transaction
  - getResultDesc
```
public String getResultDesc()
```
    Result Description if any provided by the gateway to supplement the #resultCode
  - setResultDesc
```
public void setResultDesc(String resultDesc)
```
    Result Description if any provided by the gateway to supplement the #resultCode
  - getFailureGatewayResponse
```
public String getFailureGatewayResponse()
```
    Specific reason for gateway Failure
  - setFailureGatewayResponse
```
public void setFailureGatewayResponse(String failureGatewayResponse)
```
    Specific reason for gateway Failure
  - getFailureIssuerResponse
```
public String getFailureIssuerResponse()
```
    Specific reason for issuer Failure
  - setFailureIssuerResponse
```
public void setFailureIssuerResponse(String failureIssuerResponse)
```
    Specific reason for issuer Failure
  - getActualDateTime
```
public String getActualDateTime()
```
    Date time the transaction was conducted The String format is used to preserve in format as sent by gateway
  - setActualDateTime
```
public void setActualDateTime(String actualDateTime)
```
    Date time the transaction was conducted The String format is used to preserve in format as sent by gateway
  - getDateTime
```
public Date getDateTime()
```
    When the system got the response and recorded it
    Should be set as soon as the Transaction flow returns control to the API that called the transaction and gets the Response Code.
  - setDateTime
```
public void setDateTime(Date dateTime)
```
    When the system got the response and recorded it
    Should be set as soon as the Transaction flow returns control to the API that called the transaction and gets the Response Code.
  - getType
```
public String getType()
```
    Transaction type details/code
  - setType
```
public void setType(String type)
```
    Transaction type details/code
  - getGatewayResponseJSON
```
public String getGatewayResponseJSON()
```
    Capture any other flags and attributes from the gateway in a JSON String
  - setGatewayResponseJSON
```
public void setGatewayResponseJSON(String gatewayResponseJSON)
```
    Capture any other flags and attributes from the gateway in a JSON String
  - getGatewayId
```
public String getGatewayId()
```
    Identify the Gateway / Broker
  - setGatewayId
```
public void setGatewayId(String gatewayId)
```
    Identify the Gateway / Broker
  - getGatewayRequestParams
```
public String getGatewayRequestParams()
```
    When being redirected to gateway/Service; capture the URL param details
  - setGatewayRequestParams
```
public void setGatewayRequestParams(String gatewayRequestParams)
```
    When being redirected to gateway/Service; capture the URL param details
  - getSuccess
```
public Boolean getSuccess()
```
    Was the transaction successful or Not
    Note: A Transaction may have two aspects.
    1. Where the REQUEST to the Payment Service is established
    2. Where the RESPONSE is validated from the Payment Service
    ...one should ensure success is set true ONLY when the response is successful.
  - setSuccess
```
public void setSuccess(Boolean success)
```
    Was the transaction successful or Not
    Note: A Transaction may have two aspects.
    1. Where the REQUEST to the Payment Service is established
    2. Where the RESPONSE is validated from the Payment Service
    ...one should ensure success is set true ONLY when the response is successful.
  - getAmount
```
public TransactionAmount getAmount()
```
    Transaction amount
    We want to maintain the details @ the transaction level in addition to Order because Orders may be modified.
    We can tract at the point in time, what was the exact amount transacted.
    
    Can be null:
    
    false
  - setAmount
```
public void setAmount(TransactionAmount amount)
```
    Transaction amount
    We want to maintain the details @ the transaction level in addition to Order because Orders may be modified.
    We can tract at the point in time, what was the exact amount transacted.
    
    Can be null:
    
    false
  - getFee
```
public TransactionAmount getFee()
```
    An optional transaction fee
    
    Can be null:
    
    true
  - setFee
```
public void setFee(TransactionAmount fee)
```
    An optional transaction fee
    
    Can be null:
    
    true
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class Transaction<O extends Order>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

TIME_ZONE

Constructor Detail

Transaction

Transaction

Transaction

Method Detail

getId

setId

getGatewayTransactionId

setGatewayTransactionId

getIssuerTransactionId

setIssuerTransactionId

getOrder

setOrder

getGatewayResultCode

setGatewayResultCode

getIssuerResultCode

setIssuerResultCode

getResultDesc

setResultDesc

getFailureGatewayResponse

setFailureGatewayResponse

getFailureIssuerResponse

setFailureIssuerResponse

getActualDateTime

setActualDateTime

getDateTime

setDateTime

getType

setType

getGatewayResponseJSON

setGatewayResponseJSON

getGatewayId

setGatewayId

getGatewayRequestParams

setGatewayRequestParams

getSuccess

setSuccess

getAmount

setAmount

getFee

setFee

toString