com.ibm.commerce.edp.api

Class PaymentContext

java.lang.Object

com.ibm.commerce.edp.api.PaymentContext

All Implemented Interfaces:

java.io.Serializable

public class PaymentContext
extends java.lang.Object
implements java.io.Serializable

This class represents the context information in payment, which contains payment group, locale, store ID and order channel ID.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
PaymentContext() Default constructor.
PaymentContext(java.lang.Integer storeId, java.lang.String paymentGroupId, java.util.Locale locale, java.lang.String orderChannel) This method is the constructor building a new PaymentContext
PaymentContext(java.lang.Integer storeId, java.lang.String paymentGroupId, java.util.Locale locale, java.lang.String orderChannel, java.util.Map sensitivePaymentData) This method is the constructor building a new PaymentContext
PaymentContext(java.lang.Integer storeId, java.lang.String paymentGroupId, java.util.Locale locale, java.lang.String orderChannel, java.util.Map sensitivePaymentData, java.util.Map additionalInfo) This method is the constructor building a new PaymentContext

Method Summary

Modifier and Type	Method and Description
java.util.Map	getAdditionalInformation() This method returns the additional information.
java.util.Locale	getLocale() This method returns the locale.
java.lang.String	getOrderChannel() This method returns the order channel ID.
java.lang.String	getPaymentGroupId() This method returns the payment group ID.
java.util.Map	getSensitivePaymentData()
java.lang.Integer	getStoreId() This method returns the store ID.
void	setAdditionalInformation(java.util.Map information) This method sets the additional information.
void	setLocale(java.util.Locale locale) This method sets the locale.
void	setOrderChannel(java.lang.String string) This method sets the order channel ID.
void	setPaymentGroupId(java.lang.String paymentGroupId) This method sets the payment group ID.
void	setSensitivePaymentData(java.util.Map paymentData)
void	setStoreId(java.lang.Integer integer) This method sets the store ID.
java.lang.String	toString() This method generates a human readable representation of the context.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

PaymentContext

public PaymentContext()

Default constructor.

PaymentContext

public PaymentContext(java.lang.Integer storeId,
                      java.lang.String paymentGroupId,
                      java.util.Locale locale,
                      java.lang.String orderChannel)

This method is the constructor building a new PaymentContext

Parameters:

storeId - The store ID

paymentGroupId - The payment group ID

locale - The locale

orderChannel - The order channel ID

PaymentContext

public PaymentContext(java.lang.Integer storeId,
                      java.lang.String paymentGroupId,
                      java.util.Locale locale,
                      java.lang.String orderChannel,
                      java.util.Map sensitivePaymentData)

This method is the constructor building a new PaymentContext

Parameters:

storeId - The store ID

paymentGroupId - The payment group ID

locale - The locale

orderChannel - The order channel ID

sensitivePaymentData - The payment sensitive information

PaymentContext

public PaymentContext(java.lang.Integer storeId,
                      java.lang.String paymentGroupId,
                      java.util.Locale locale,
                      java.lang.String orderChannel,
                      java.util.Map sensitivePaymentData,
                      java.util.Map additionalInfo)

This method is the constructor building a new PaymentContext

Parameters:

storeId - The store ID

paymentGroupId - The payment group ID

locale - The locale

orderChannel - The order channel ID

sensitivePaymentData - The payment sensitive information

additionalInfo - The additional information

Method Detail

setLocale

public final void setLocale(java.util.Locale locale)

This method sets the locale.

Parameters:

locale - The locale to set

getLocale

public final java.util.Locale getLocale()

This method returns the locale.

Returns:

Locale The locale

setOrderChannel

public final void setOrderChannel(java.lang.String string)

This method sets the order channel ID.

Parameters:

string - The order channel ID to set

getOrderChannel

public final java.lang.String getOrderChannel()

This method returns the order channel ID.

Returns:

String The order channel ID

setPaymentGroupId

public final void setPaymentGroupId(java.lang.String paymentGroupId)

This method sets the payment group ID.

Parameters:

paymentGroupId - The payment group ID

getPaymentGroupId

public final java.lang.String getPaymentGroupId()

This method returns the payment group ID.

Returns:

The payment group ID

setStoreId

public final void setStoreId(java.lang.Integer integer)

This method sets the store ID.

Parameters:

integer - The store ID

getStoreId

public final java.lang.Integer getStoreId()

This method returns the store ID.

Returns:

Integer The store ID

toString

public java.lang.String toString()

This method generates a human readable representation of the context.

Overrides:

toString in class java.lang.Object

Returns:

A human readable representation of the context

getSensitivePaymentData

public java.util.Map getSensitivePaymentData()

Returns:

Returns the _sensitivePaymentData.

setSensitivePaymentData

public void setSensitivePaymentData(java.util.Map paymentData)

Parameters:

paymentData - The _sensitivePaymentData to set.

getAdditionalInformation

public java.util.Map getAdditionalInformation()

This method returns the additional information.

Returns:

Returns the _additionalInformation.

setAdditionalInformation

public void setAdditionalInformation(java.util.Map information)

This method sets the additional information.

Parameters:

information - The _additionalInformation to set.