Module com.aoapps.payments.api

Package com.aoapps.payments

Class TransactionResult

java.lang.Object

com.aoapps.payments.TransactionResult

Direct Known Subclasses:

AuthorizationResult, CaptureResult, CreditResult, VoidResult

public abstract class TransactionResult
extends Object

Encapsulates the results of any type of transaction with the merchant services provider.

Author:

AO Industries, Inc.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	TransactionResult.CommunicationResult	The set of supported communication results.
static enum	TransactionResult.ErrorCode	The set of supported error codes.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	TransactionResult(String providerId, TransactionResult.CommunicationResult communicationResult, String providerErrorCode, TransactionResult.ErrorCode errorCode, String providerErrorMessage, String providerUniqueId)	Creates a new TransactionResult.

Method Summary

Modifier and Type	Method	Description
TransactionResult.CommunicationResult	getCommunicationResult()	Gets the communication result.
TransactionResult.ErrorCode	getErrorCode()	Gets the provider-neutral error code.
String	getProviderErrorCode()	Gets the provider-specific error code.
String	getProviderErrorMessage()	Gets the provider-specific error message.
String	getProviderId()	Gets the id of the provider that processed this transaction.
String	getProviderUniqueId()	Gets the provider-specific unique identifier.

Methods inherited from class java.lang.Object

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

Constructor Details

TransactionResult

protected TransactionResult(String providerId,
 TransactionResult.CommunicationResult communicationResult,
 String providerErrorCode,
 TransactionResult.ErrorCode errorCode,
 String providerErrorMessage,
 String providerUniqueId)

Creates a new TransactionResult.

Method Details

getProviderId

public String getProviderId()

Gets the id of the provider that processed this transaction.

getCommunicationResult

public TransactionResult.CommunicationResult getCommunicationResult()

Gets the communication result. This should be the first thing checked after any attempt to access the MerchantServicesProvider.

getProviderErrorCode

public String getProviderErrorCode()

Gets the provider-specific error code.

See Also:

• getErrorCode()

getErrorCode

public TransactionResult.ErrorCode getErrorCode()

Gets the provider-neutral error code.

getProviderErrorMessage

public String getProviderErrorMessage()

Gets the provider-specific error message.

getProviderUniqueId

public String getProviderUniqueId()

Gets the provider-specific unique identifier.