atg.integrations.cybercash
Class CyberCashStatus

java.lang.Object
  extended by atg.payment.creditcard.AuthorizationAddressVerificationStatus
      extended by atg.integrations.cybercash.CyberCashStatus
All Implemented Interfaces:
CreditCardStatus, PaymentStatus, java.io.Serializable

public class CyberCashStatus
extends AuthorizationAddressVerificationStatus

This class encapsulates a standard CyberCash response. This data comes back from a majority of the commands.

See Also:
Serialized Form

Field Summary
static java.lang.String CLASS_VERSION
           
static int LOC_BANK
          The command failed at the bank.
static int LOC_CYBERCASH_SERVER
          The command failed at the CyberCash gateway server.
static int LOC_LOCAL_SERVER
          The command failed at the local payment server.
static int LOC_UNKNOWN
          Unknown location, this occurs there is no error.
static int STAT_DUPLICATE_SUCCESS
          Retrying an command that has already succeded.
static int STAT_FAIL
          The command failed, no retry is possible.
static int STAT_FAIL_BANK
          The command failed, bank reported an error.
static int STAT_FAIL_RETRY
          The command failed, retry is possible.
static int STAT_FAIL_VERSION
          The command failed, version incompatible.
static int STAT_SUCCESS
          The command was a complete success in all possible ways.
static int STAT_UNKNOWN
          Unknown status, if this occurs there is a bug.
 
Constructor Summary
CyberCashStatus(java.util.Dictionary values)
          Constructs a CyberCashResponse with initial values.
 
Method Summary
 double getAmount()
          The amount that was submitted for the transaction
 java.util.Date getAuthorizationExpiration()
          Authorization expiration date returned by some payment systems
 java.lang.String getAvsCode()
          Address Verification Result returned from authorization
 java.lang.String getAvsDescriptiveResult()
          A full descriptive address verification result message
 java.lang.String getErrorCode()
          Gets property errorCode.
 java.lang.String getErrorMessage()
          A message describing the transaction failure
 int getLocation()
          Gets property location.
 int getStatus()
          Gets property status.
 java.lang.String getTransactionId()
          A unique transaction Id returned from the payment system
 boolean getTransactionSuccess()
          Indicates if the transaction succeeded or failed
 java.util.Date getTransactionTimestamp()
          Date when the transaction is initiated
 java.lang.Object getValue(java.lang.String key)
          Gets a single property value from the values dictionary of the raw data from the CyberCash server.
 java.util.Dictionary getValues()
          Gets property values.
 void setAmount(double pAmount)
           
 void setAuthorizationExpiration(java.util.Date pAuthorizationExpiration)
           
 void setAvsCode(java.lang.String pAvsCode)
           
 void setAvsDescriptiveResult(java.lang.String pAvsDescriptiveResult)
           
 void setErrorCode(java.lang.String pErrorCode)
          Sets property errorCode.
 void setErrorMessage(java.lang.String pErrorMessage)
           
 void setLocation(int pLocation)
          Sets property location.
 void setStatus(int pStatus)
          Sets property status.
 void setTransactionId(java.lang.String pTransactionId)
           
 void setTransactionSuccess(boolean pTransactionSuccess)
           
 void setTransactionTimestamp(java.util.Date pTransactionTimestamp)
           
 void setValues(java.util.Dictionary pValues)
          Sets property values.
 java.lang.String toString()
           
 
Methods inherited from class atg.payment.creditcard.AuthorizationAddressVerificationStatus
getAvsDescriptiveValue
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

CLASS_VERSION

public static java.lang.String CLASS_VERSION

STAT_UNKNOWN

public static final int STAT_UNKNOWN
Unknown status, if this occurs there is a bug.

See Also:
Constant Field Values

STAT_SUCCESS

public static final int STAT_SUCCESS
The command was a complete success in all possible ways.

See Also:
Constant Field Values

STAT_DUPLICATE_SUCCESS

public static final int STAT_DUPLICATE_SUCCESS
Retrying an command that has already succeded.

See Also:
Constant Field Values

STAT_FAIL

public static final int STAT_FAIL
The command failed, no retry is possible.

See Also:
Constant Field Values

STAT_FAIL_RETRY

public static final int STAT_FAIL_RETRY
The command failed, retry is possible.

See Also:
Constant Field Values

STAT_FAIL_VERSION

public static final int STAT_FAIL_VERSION
The command failed, version incompatible.

See Also:
Constant Field Values

STAT_FAIL_BANK

public static final int STAT_FAIL_BANK
The command failed, bank reported an error.

See Also:
Constant Field Values

LOC_UNKNOWN

public static final int LOC_UNKNOWN
Unknown location, this occurs there is no error.

See Also:
Constant Field Values

LOC_LOCAL_SERVER

public static final int LOC_LOCAL_SERVER
The command failed at the local payment server.

See Also:
Constant Field Values

LOC_CYBERCASH_SERVER

public static final int LOC_CYBERCASH_SERVER
The command failed at the CyberCash gateway server.

See Also:
Constant Field Values

LOC_BANK

public static final int LOC_BANK
The command failed at the bank.

See Also:
Constant Field Values
Constructor Detail

CyberCashStatus

public CyberCashStatus(java.util.Dictionary values)
Constructs a CyberCashResponse with initial values.

Method Detail

getTransactionId

public java.lang.String getTransactionId()
Description copied from interface: PaymentStatus
A unique transaction Id returned from the payment system


setTransactionId

public void setTransactionId(java.lang.String pTransactionId)

getAmount

public double getAmount()
Description copied from interface: PaymentStatus
The amount that was submitted for the transaction


setAmount

public void setAmount(double pAmount)

getTransactionSuccess

public boolean getTransactionSuccess()
Description copied from interface: PaymentStatus
Indicates if the transaction succeeded or failed


setTransactionSuccess

public void setTransactionSuccess(boolean pTransactionSuccess)

getErrorMessage

public java.lang.String getErrorMessage()
Description copied from interface: PaymentStatus
A message describing the transaction failure


setErrorMessage

public void setErrorMessage(java.lang.String pErrorMessage)

getTransactionTimestamp

public java.util.Date getTransactionTimestamp()
Description copied from interface: PaymentStatus
Date when the transaction is initiated


setTransactionTimestamp

public void setTransactionTimestamp(java.util.Date pTransactionTimestamp)

getAuthorizationExpiration

public java.util.Date getAuthorizationExpiration()
Description copied from interface: CreditCardStatus
Authorization expiration date returned by some payment systems


setAuthorizationExpiration

public void setAuthorizationExpiration(java.util.Date pAuthorizationExpiration)

setAvsCode

public void setAvsCode(java.lang.String pAvsCode)

getAvsCode

public java.lang.String getAvsCode()
Description copied from interface: CreditCardStatus
Address Verification Result returned from authorization


setAvsDescriptiveResult

public void setAvsDescriptiveResult(java.lang.String pAvsDescriptiveResult)

getAvsDescriptiveResult

public java.lang.String getAvsDescriptiveResult()
Description copied from interface: CreditCardStatus
A full descriptive address verification result message


setValues

public void setValues(java.util.Dictionary pValues)
Sets property values. This is a dictionary of the raw data from the CyberCash server. When a new one is set, use it to determine some common values and cache them in properties. For now both keys and values are strings, but this may change in the furture.


getValues

public java.util.Dictionary getValues()
Gets property values. This is a dictionary of the raw data from the CyberCash server. For now both keys and values are strings, but this may change in the furture.


getValue

public java.lang.Object getValue(java.lang.String key)
Gets a single property value from the values dictionary of the raw data from the CyberCash server. For now both keys and values are strings, but this may change in the furture.


setStatus

public void setStatus(int pStatus)
Sets property status.


getStatus

public int getStatus()
Gets property status.


setLocation

public void setLocation(int pLocation)
Sets property location.


getLocation

public int getLocation()
Gets property location.


setErrorCode

public void setErrorCode(java.lang.String pErrorCode)
Sets property errorCode.


getErrorCode

public java.lang.String getErrorCode()
Gets property errorCode.


toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object
Returns:
a String representation of this object