org.apache.ofbiz.accounting.thirdparty.eway

Class GatewayResponse

java.lang.Object

org.apache.ofbiz.accounting.thirdparty.eway.GatewayResponse

public class GatewayResponse
extends Object

A class representing the payment gateway's response to a request. It holds fields of the response which are filled in when the response arrives and available through getter methods. This response class supports all 3 payment methods. Based on public domain sample code provided by eWay.com.au

Constructor Summary

Constructors

Constructor and Description
GatewayResponse(InputStream xmlstream, GatewayRequest req) Creates the GatewayResponse object by parsing an xml from a stream.

Method Summary

Modifier and Type	Method and Description
String	getAuthCode()
double	getBeagleScore() Gets the beagle score.
int	getReturnAmount()
BigDecimal	getTransactionAmount()
String	getTrxnError()
String	getTrxnNumber()
String	getTrxnOption1()
String	getTrxnOption2()
String	getTrxnOption3()
String	getTrxnReference()
boolean	getTrxnStatus()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

GatewayResponse

public GatewayResponse(InputStream xmlstream,
                       GatewayRequest req)
                throws Exception

Creates the GatewayResponse object by parsing an xml from a stream. Fills in the fields of the object that are available through getters after this method returns.

Parameters:

xmlstream - the stream to parse the response from

Throws:

Exception - if the xml contains a root element with a bad name or an unknown element, or if the xml is badly formatted

Method Detail

getTrxnNumber

public String getTrxnNumber()

getTrxnReference

public String getTrxnReference()

getTrxnOption1

public String getTrxnOption1()

getTrxnOption2

public String getTrxnOption2()

getTrxnOption3

public String getTrxnOption3()

getAuthCode

public String getAuthCode()

getTrxnError

public String getTrxnError()

getReturnAmount

public int getReturnAmount()

getTransactionAmount

public BigDecimal getTransactionAmount()

getTrxnStatus

public boolean getTrxnStatus()

getBeagleScore

public double getBeagleScore()

Gets the beagle score. Defaults to -1 in case of non-Beagle payment methods or if the response does not contain this field.

Returns:

The beagle score or -1 if it was not defined in the response

toString

public String toString()

Overrides:

toString in class Object