atg.commerce.payment

Class PaymentManagerPipelineArgs

java.lang.Object

java.util.AbstractMap<K,V>

java.util.HashMap

atg.commerce.payment.PaymentManagerPipelineArgs

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.util.Map

public class PaymentManagerPipelineArgs
extends java.util.HashMap

Argument dictionary for pipeline chains and processors invoked by the PaymentManager. This class provides standard typesafe API's for storing and retrieving common information in the dictionary using well-known dictionary keys. An instance of this class will be passed as the argument to the runProcess method of any pipeline chain used by the PaymentManager.

See Also:

PaymentManager, PipelineProcessor, Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class java.util.AbstractMap

java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

java.util.Map.Entry<K,V>

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASS_VERSION

Constructor Summary

Constructors

Constructor and Description
PaymentManagerPipelineArgs()
PaymentManagerPipelineArgs(int pSize)
PaymentManagerPipelineArgs(int pSize, float pLoadFactor)

Method Summary

Modifier and Type	Method and Description
PaymentManagerAction	getAction() Get the action being performed from the argument dictionary.
double	getAmount() Get the payment amount from the argument dictionary.
Order	getOrder() Get the current Order from the argument dictionary.
PaymentGroup	getPaymentGroup() Get the current PaymentGroup from the argument dictionary.
java.lang.Object	getPaymentInfo() Get the generic payment information from the argument dictionary.
PaymentManager	getPaymentManager() Get the current PaymentManager from the argument dictionary.
PaymentStatus	getPaymentStatus() Get the result status of the current operation from the argument dictionary.
void	setAction(PaymentManagerAction pAction) Add the action being performed to the argument dictionary.
void	setAmount(double pAmount) Add the payment amount to the argument dictionary.
void	setOrder(Order pOrder) Add the current Order to the argument dictionary.
void	setPaymentGroup(PaymentGroup pPayment) Add the current PaymentGroup to the argument dictionary.
void	setPaymentInfo(java.lang.Object pInfo) Add a generic payment information object to the argument dictionary.
void	setPaymentManager(PaymentManager pManager) Add the current PaymentManager to the argument dictionary.
void	setPaymentStatus(PaymentStatus pStatus) Add the result status of the current operation to the argument dictionary.

Methods inherited from class java.util.HashMap

clear, clone, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, forEach, get, getOrDefault, isEmpty, keySet, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size, values

Methods inherited from class java.util.AbstractMap

equals, hashCode, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

equals, hashCode

Field Detail

CLASS_VERSION

public static java.lang.String CLASS_VERSION

Constructor Detail

PaymentManagerPipelineArgs

public PaymentManagerPipelineArgs()

PaymentManagerPipelineArgs

public PaymentManagerPipelineArgs(int pSize)

PaymentManagerPipelineArgs

public PaymentManagerPipelineArgs(int pSize,
                                  float pLoadFactor)

Method Detail

setOrder

public void setOrder(Order pOrder)

Add the current Order to the argument dictionary.

getOrder

public Order getOrder()

Get the current Order from the argument dictionary.

setPaymentManager

public void setPaymentManager(PaymentManager pManager)

Add the current PaymentManager to the argument dictionary.

getPaymentManager

public PaymentManager getPaymentManager()

Get the current PaymentManager from the argument dictionary.

setPaymentGroup

public void setPaymentGroup(PaymentGroup pPayment)

Add the current PaymentGroup to the argument dictionary.

getPaymentGroup

public PaymentGroup getPaymentGroup()

Get the current PaymentGroup from the argument dictionary. Callers may need to downcast the resulting PaymentGroup reference to the particular PaymentGroup type they are expecting.

setAmount

public void setAmount(double pAmount)

Add the payment amount to the argument dictionary.

getAmount

public double getAmount()

Get the payment amount from the argument dictionary.

setAction

public void setAction(PaymentManagerAction pAction)

Add the action being performed to the argument dictionary. The action must be one of the following constants: PaymentManagerAction.AUTHORIZE, PaymentManagerAction.DEBIT, or PaymentManagerAction.CREDIT.

getAction

public PaymentManagerAction getAction()

Get the action being performed from the argument dictionary. The action will be one of the following constants: PaymentManagerAction.AUTHORIZE, PaymentManagerAction.DEBIT, or PaymentManagerAction.CREDIT.

setPaymentInfo

public void setPaymentInfo(java.lang.Object pInfo)

Add a generic payment information object to the argument dictionary.

getPaymentInfo

public java.lang.Object getPaymentInfo()

Get the generic payment information from the argument dictionary. Callers may need to downcast the resulting Object reference to the particular type they are expecting (e.g., CreditCardInfo or StoreCreditInfo).

setPaymentStatus

public void setPaymentStatus(PaymentStatus pStatus)

Add the result status of the current operation to the argument dictionary.

getPaymentStatus

public PaymentStatus getPaymentStatus()

Get the result status of the current operation from the argument dictionary.