TransactionEvent

public class TransactionEvent

The listener interface for session events. More than one listener may be registered with a session, but there must always be at least one listener.

Fields

LOGIN_COMPLETED

public static final String LOGIN_COMPLETED

The login process is complete, check the status for the success/failure of the attempt.

LOGOUT_COMPLETED

public static final String LOGOUT_COMPLETED

The logout process is complete, check the status for the success/failure of the attempt

RECEIPT_PRINTED

public static final String RECEIPT_PRINTED

The event type when receipt is printed.

RECEIPT_REPRINTED

public static final String RECEIPT_REPRINTED

Sent in response to TransactionManager.reprintReceipt(Payment,int,int,String). Only this type and the status will always be provided, since it might not be attached to a session or a transaction.

TRANSACTION_ENDED

public static final String TRANSACTION_ENDED

The event type when an action has ended for non-Payment types.

TRANSACTION_ERROR

public static final String TRANSACTION_ERROR

A general type when an error has occurred during the transaction.

TRANSACTION_FAILED

public static final String TRANSACTION_FAILED

The transaction has failed. It will need to be started again.

TRANSACTION_NOTIFICATION

public static final String TRANSACTION_NOTIFICATION

A general transaction event notifying listeners that something has happened.

TRANSACTION_PAYMENT_COMPLETED

public static final String TRANSACTION_PAYMENT_COMPLETED

The event type when a payment has been completed.

TRANSACTION_PAYMENT_REQUIRES_ONLINE_AUTHORIZATION

public static final String TRANSACTION_PAYMENT_REQUIRES_ONLINE_AUTHORIZATION

The event type when a payment requires online authorization. An event with this type will only be sent when the client is performing online authorization itself.

TRANSACTION_PAYMENT_STARTED

public static final String TRANSACTION_PAYMENT_STARTED

The event type when a payment has started.

TRANSACTION_REQUEST

public static final String TRANSACTION_REQUEST

A general transaction event requesting information from listeners.

TRANSACTION_STARTED

public static final String TRANSACTION_STARTED

The event type when an action has started for non-Payment types.

Methods

generateTransactionEventResponse

public TransactionEventResponse generateTransactionEventResponse()

Return transaction event response

getEventId

public String getEventId()

Returns an optional event ID as copied from the originating event.

getInvoiceId

public String getInvoiceId()

The invoice ID for the transaction.

getMessage

public String getMessage()

Return message from event

getSessionId

public String getSessionId()

Returns the session ID associated with this event, or null if detached from a session.

getStatus

public int getStatus()

Return status

getTransaction

public Transaction getTransaction()

The transaction object. Use updateTransaction(Transaction) to apply any changes for the transaction, or just update the transaction object returned by this method.

getType

public String getType()

Returns the Transaction Event constants in addition to the CommerceEvent and Status constants. Overridden here only to provide the appropriate documentation.