com.konakart.app

Class PaymentDetails

java.lang.Object

com.konakart.app.PaymentDetails

All Implemented Interfaces:

PaymentDetailsIf

public class PaymentDetails
extends java.lang.Object
implements PaymentDetailsIf

The PaymentDetails for the Payment Modules

Field Summary

Fields

Modifier and Type	Field and Description
static int	BANK_TRANSFER Bank Transfer
static int	BROWSER_IN_FRAME_PAYMENT_GATEWAY Pay through a payment gateway using their UI in a frame within the KonaKart storefront app
static int	BROWSER_PAYMENT_GATEWAY Pay through a payment gateway using their UI
static int	COD Cash on delivery
static int	CUSTOMER_CARD Customer Card
static int	FREE Free
static int	SERVER_PAYMENT_GATEWAY Pay through a payment gateway using KonaKart UI

Constructor Summary

Constructors

Constructor and Description
PaymentDetails()

Method Summary

Modifier and Type	Method and Description
PaymentDetailsIf	cloneMainAttributes() Clones the main attributes of the PaymentDetailsIf object
java.lang.String	getCcCVV()
java.lang.String	getCcExpiryMonth()
java.lang.String	getCcExpiryYear()
java.lang.String	getCcNumber()
java.lang.String	getCcOwner()
java.lang.String	getCcPostcode()
java.lang.String	getCcStreetAddress()
java.lang.String	getCcType()
java.lang.String	getCode() The code of the payment gateway.
CreditCardIf[]	getCreditCards() Contains a list of available credit cards
java.lang.String	getCustom1()
java.lang.String	getCustom2()
java.lang.String	getCustom3()
java.lang.String	getCustom4()
java.lang.String	getCustom5()
java.lang.String	getDescription() The payment gateway description to put on the UI so that it can be selected.
int	getOrderStatusId()
NameValueIf[]	getParameters() An array of name value pairs which are the parameters that will be posted to the payment gateway.
PaymentDetailsIf[]	getPaymentDetails() The payment details object may consist of more than one payment details objects.
int	getPaymentType() The supported payment types are: com.konakart.app.PaymentDetails.COD - Cash on delivery com.konakart.app.PaymentDetails.BROWSER_PAYMENT_GATEWAY - Payment gateway where user is redirected to gateway server to enter credit card details e.g.
java.lang.String	getPostOrGet() Defines whether to use a POST or GET to send the parameters.
java.lang.String	getPreProcessCode() Information for framework to indicate that some pre-processing code needs to be run for this Payment Gateway
java.lang.String	getReferrer() Gets the Referrer - sometimes required to be set on an HTTP post.
java.lang.String	getRequestUrl() The payment gateway url.
int	getSortOrder() Defines the order in which the payment gateways are displayed.
java.lang.String	getSubCode() One PaymentDetails code can have multiple subCodes as well (eg.
int	getSubSortOrder() Defines the subSortOrder in which the payment gateways are displayed - order first by sortOrder, then by subSortOrder.
java.lang.String	getTitle() The title of the payment gateway which can be used in the UI.
boolean	isShowAddr() If set to true, the UI page where credit card details are entered, will display an address field.
boolean	isShowCVV() If set to true, the UI page where credit card details are entered, will display a CVV field.
boolean	isShowOwner() If set to true, the UI page where credit card details are entered, will display an owner field to enter the name of the credit card owner.
boolean	isShowPostcode() If set to true, the UI page where credit card details are entered, will display a postcode field.
boolean	isShowType() If set to true, the UI page where credit card details are entered, will display a a credit card type field.
void	setCcCVV(java.lang.String ccCVV)
void	setCcExpiryMonth(java.lang.String ccExpiryMonth)
void	setCcExpiryYear(java.lang.String ccExpiryYear)
void	setCcNumber(java.lang.String ccNumber)
void	setCcOwner(java.lang.String ccOwner)
void	setCcPostcode(java.lang.String ccPostcode)
void	setCcStreetAddress(java.lang.String ccStreetAddress)
void	setCcType(java.lang.String ccType)
void	setCode(java.lang.String code) The code of the payment gateway.
void	setCreditCards(CreditCardIf[] creditCards) Contains a list of available credit cards
void	setCustom1(java.lang.String custom1)
void	setCustom2(java.lang.String custom2)
void	setCustom3(java.lang.String custom3)
void	setCustom4(java.lang.String custom4)
void	setCustom5(java.lang.String custom5)
void	setDescription(java.lang.String description) The payment gateway description to put on the UI so that it can be selected.
void	setOrderStatusId(int orderStatusId)
void	setParameters(NameValueIf[] parameters) An array of name value pairs which are the parameters that will be posted to the payment gateway.
void	setPaymentDetails(PaymentDetailsIf[] paymentDetails) The payment details object may consist of more than one payment details objects.
void	setPaymentType(int paymentType) The supported payment types are: com.konakart.app.PaymentDetails.COD - Cash on delivery com.konakart.app.PaymentDetails.BROWSER_PAYMENT_GATEWAY - Payment gateway where user is redirected to gateway server to enter credit card details e.g.
void	setPostOrGet(java.lang.String postOrGet) Defines whether to use a POST or GET to send the parameters.
void	setPreProcessCode(java.lang.String preProcessCode) Information for framework to indicate that some pre-processing code needs to be run for this Payment Gateway
void	setReferrer(java.lang.String referrer) Sets the Referrer - sometimes required to be set on an HTTP post.
void	setRequestUrl(java.lang.String requestUrl) The payment gateway url.
void	setShowAddr(boolean showAddr) If set to true, the UI page where credit card details are entered, will display an address field.
void	setShowCVV(boolean showCVV) If set to true, the UI page where credit card details are entered, will display a CVV field.
void	setShowOwner(boolean showOwner) If set to true, the UI page where credit card details are entered, will display an owner field to enter the name of the credit card owner.
void	setShowPostcode(boolean showPostcode) If set to true, the UI page where credit card details are entered, will display a postcode field.
void	setShowType(boolean showType) If set to true, the UI page where credit card details are entered, will display a credit card type field.
void	setSortOrder(int sortOrder) Defines the order in which the payment gateways are displayed - order first by sortOrder, then by subSortOrder.
void	setSubCode(java.lang.String subCode) One PaymentDetails code can have multiple subCodes as well (eg.
void	setSubSortOrder(int subSortOrder) Defines the subSortOrder in which the payment gateways are displayed - order first by sortOrder, then by subSortOrder.
void	setTitle(java.lang.String title) The title of the payment gateway which can be used in the UI.
java.lang.String	toString() Returns a string containing the attributes of the PaymentDetail object

Methods inherited from class java.lang.Object

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

Field Detail

COD

public static final int COD

Cash on delivery

See Also:

Constant Field Values

BROWSER_PAYMENT_GATEWAY

public static final int BROWSER_PAYMENT_GATEWAY

Pay through a payment gateway using their UI

See Also:

Constant Field Values

SERVER_PAYMENT_GATEWAY

public static final int SERVER_PAYMENT_GATEWAY

Pay through a payment gateway using KonaKart UI

See Also:

Constant Field Values

BROWSER_IN_FRAME_PAYMENT_GATEWAY

public static final int BROWSER_IN_FRAME_PAYMENT_GATEWAY

Pay through a payment gateway using their UI in a frame within the KonaKart storefront app

See Also:

Constant Field Values

CUSTOMER_CARD

public static final int CUSTOMER_CARD

Customer Card

See Also:

Constant Field Values

BANK_TRANSFER

public static final int BANK_TRANSFER

Bank Transfer

See Also:

Constant Field Values

FREE

public static final int FREE

Free

See Also:

Constant Field Values

Constructor Detail

PaymentDetails

public PaymentDetails()

Method Detail

toString

public java.lang.String toString()

Returns a string containing the attributes of the PaymentDetail object

Overrides:

toString in class java.lang.Object

getParameters

public NameValueIf[] getParameters()

Description copied from interface: PaymentDetailsIf

An array of name value pairs which are the parameters that will be posted to the payment gateway.

Specified by:

getParameters in interface PaymentDetailsIf

Returns:

Returns the parameters.

setParameters

public void setParameters(NameValueIf[] parameters)

Description copied from interface: PaymentDetailsIf

An array of name value pairs which are the parameters that will be posted to the payment gateway.

Specified by:

setParameters in interface PaymentDetailsIf

Parameters:

parameters - The parameters to set.

getPostOrGet

public java.lang.String getPostOrGet()

Description copied from interface: PaymentDetailsIf

Defines whether to use a POST or GET to send the parameters. Should be set to "post" or "get".

Specified by:

getPostOrGet in interface PaymentDetailsIf

Returns:

Returns the postOrGet.

setPostOrGet

public void setPostOrGet(java.lang.String postOrGet)

Description copied from interface: PaymentDetailsIf

Defines whether to use a POST or GET to send the parameters. Should be set to "post" or "get".

Specified by:

setPostOrGet in interface PaymentDetailsIf

Parameters:

postOrGet - The postOrGet to set.

getRequestUrl

public java.lang.String getRequestUrl()

Description copied from interface: PaymentDetailsIf

The payment gateway url.

Specified by:

getRequestUrl in interface PaymentDetailsIf

Returns:

Returns the requestUrl.

setRequestUrl

public void setRequestUrl(java.lang.String requestUrl)

Description copied from interface: PaymentDetailsIf

The payment gateway url.

Specified by:

setRequestUrl in interface PaymentDetailsIf

Parameters:

requestUrl - The requestUrl to set.

getCode

public java.lang.String getCode()

Description copied from interface: PaymentDetailsIf

The code of the payment gateway. e.g. chronopay, worldpay etc.

Specified by:

getCode in interface PaymentDetailsIf

Returns:

Returns the code.

setCode

public void setCode(java.lang.String code)

Description copied from interface: PaymentDetailsIf

The code of the payment gateway. e.g. chronopay, worldpay etc.

Specified by:

setCode in interface PaymentDetailsIf

Parameters:

code - The code to set.

getDescription

public java.lang.String getDescription()

Description copied from interface: PaymentDetailsIf

The payment gateway description to put on the UI so that it can be selected.

Specified by:

getDescription in interface PaymentDetailsIf

Returns:

Returns the description.

setDescription

public void setDescription(java.lang.String description)

Description copied from interface: PaymentDetailsIf

The payment gateway description to put on the UI so that it can be selected.

Specified by:

setDescription in interface PaymentDetailsIf

Parameters:

description - The description to set.

getSortOrder

public int getSortOrder()

Description copied from interface: PaymentDetailsIf

Defines the order in which the payment gateways are displayed.

Specified by:

getSortOrder in interface PaymentDetailsIf

Returns:

Returns the sortOrder.

setSortOrder

public void setSortOrder(int sortOrder)

Description copied from interface: PaymentDetailsIf

Defines the order in which the payment gateways are displayed - order first by sortOrder, then by subSortOrder.

Specified by:

setSortOrder in interface PaymentDetailsIf

Parameters:

sortOrder - The sortOrder to set.

getTitle

public java.lang.String getTitle()

Description copied from interface: PaymentDetailsIf

The title of the payment gateway which can be used in the UI.

Specified by:

getTitle in interface PaymentDetailsIf

Returns:

Returns the title.

setTitle

public void setTitle(java.lang.String title)

Description copied from interface: PaymentDetailsIf

The title of the payment gateway which can be used in the UI.

Specified by:

setTitle in interface PaymentDetailsIf

Parameters:

title - The title to set.

getOrderStatusId

public int getOrderStatusId()

Specified by:

getOrderStatusId in interface PaymentDetailsIf

Returns:

Returns the orderStatusId.

setOrderStatusId

public void setOrderStatusId(int orderStatusId)

Specified by:

setOrderStatusId in interface PaymentDetailsIf

Parameters:

orderStatusId - The orderStatusId to set.

getPaymentType

public int getPaymentType()

Description copied from interface: PaymentDetailsIf

The supported payment types are:

• com.konakart.app.PaymentDetails.COD - Cash on delivery
• com.konakart.app.PaymentDetails.BROWSER_PAYMENT_GATEWAY - Payment gateway where user is redirected to gateway server to enter credit card details e.g. chronopay, worldpay
• com.konakart.app.PaymentDetails.SERVER_PAYMENT_GATEWAY - Payment gateway where credit card details are collected on a KonaKart web page and sent server to server to the payment gateway. e.g. usaepay

Specified by:

getPaymentType in interface PaymentDetailsIf

Returns:

Returns the paymentType.

setPaymentType

public void setPaymentType(int paymentType)

Description copied from interface: PaymentDetailsIf

The supported payment types are:

• com.konakart.app.PaymentDetails.COD - Cash on delivery
• com.konakart.app.PaymentDetails.BROWSER_PAYMENT_GATEWAY - Payment gateway where user is redirected to gateway server to enter credit card details e.g. chronopay, worldpay
• com.konakart.app.PaymentDetails.SERVER_PAYMENT_GATEWAY - Payment gateway where credit card details are collected on a KonaKart web page and sent server to server to the payment gateway. e.g. usaepay

Specified by:

setPaymentType in interface PaymentDetailsIf

Parameters:

paymentType - The paymentType to set.

getCcNumber

public java.lang.String getCcNumber()

Specified by:

getCcNumber in interface PaymentDetailsIf

Returns:

Returns the ccNumber.

setCcNumber

public void setCcNumber(java.lang.String ccNumber)

Specified by:

setCcNumber in interface PaymentDetailsIf

Parameters:

ccNumber - The ccNumber to set.

getCcPostcode

public java.lang.String getCcPostcode()

Specified by:

getCcPostcode in interface PaymentDetailsIf

Returns:

Returns the ccPostcode.

setCcPostcode

public void setCcPostcode(java.lang.String ccPostcode)

Specified by:

setCcPostcode in interface PaymentDetailsIf

Parameters:

ccPostcode - The ccPostcode to set.

getCcStreetAddress

public java.lang.String getCcStreetAddress()

Specified by:

getCcStreetAddress in interface PaymentDetailsIf

Returns:

Returns the ccStreetAddress.

setCcStreetAddress

public void setCcStreetAddress(java.lang.String ccStreetAddress)

Specified by:

setCcStreetAddress in interface PaymentDetailsIf

Parameters:

ccStreetAddress - The ccStreetAddress to set.

getCustom1

public java.lang.String getCustom1()

Specified by:

getCustom1 in interface PaymentDetailsIf

Returns:

Returns the custom1.

setCustom1

public void setCustom1(java.lang.String custom1)

Specified by:

setCustom1 in interface PaymentDetailsIf

Parameters:

custom1 - The custom1 to set.

getCustom2

public java.lang.String getCustom2()

Specified by:

getCustom2 in interface PaymentDetailsIf

Returns:

Returns the custom2.

setCustom2

public void setCustom2(java.lang.String custom2)

Specified by:

setCustom2 in interface PaymentDetailsIf

Parameters:

custom2 - The custom2 to set.

getCustom3

public java.lang.String getCustom3()

Specified by:

getCustom3 in interface PaymentDetailsIf

Returns:

Returns the custom3.

setCustom3

public void setCustom3(java.lang.String custom3)

Specified by:

setCustom3 in interface PaymentDetailsIf

Parameters:

custom3 - The custom3 to set.

getCustom4

public java.lang.String getCustom4()

Specified by:

getCustom4 in interface PaymentDetailsIf

Returns:

Returns the custom4.

setCustom4

public void setCustom4(java.lang.String custom4)

Specified by:

setCustom4 in interface PaymentDetailsIf

Parameters:

custom4 - The custom4 to set.

getCustom5

public java.lang.String getCustom5()

Specified by:

getCustom5 in interface PaymentDetailsIf

Returns:

Returns the custom5.

setCustom5

public void setCustom5(java.lang.String custom5)

Specified by:

setCustom5 in interface PaymentDetailsIf

Parameters:

custom5 - The custom5 to set.

getCcCVV

public java.lang.String getCcCVV()

Specified by:

getCcCVV in interface PaymentDetailsIf

Returns:

Returns the ccCVV.

setCcCVV

public void setCcCVV(java.lang.String ccCVV)

Specified by:

setCcCVV in interface PaymentDetailsIf

Parameters:

ccCVV - The ccCVV to set.

getCcOwner

public java.lang.String getCcOwner()

Specified by:

getCcOwner in interface PaymentDetailsIf

Returns:

Returns the ccOwner.

setCcOwner

public void setCcOwner(java.lang.String ccOwner)

Specified by:

setCcOwner in interface PaymentDetailsIf

Parameters:

ccOwner - The ccOwner to set.

getCcType

public java.lang.String getCcType()

Specified by:

getCcType in interface PaymentDetailsIf

Returns:

Returns the ccType.

setCcType

public void setCcType(java.lang.String ccType)

Specified by:

setCcType in interface PaymentDetailsIf

Parameters:

ccType - The ccType to set.

isShowAddr

public boolean isShowAddr()

Description copied from interface: PaymentDetailsIf

If set to true, the UI page where credit card details are entered, will display an address field.

Specified by:

isShowAddr in interface PaymentDetailsIf

Returns:

Returns the showAddr.

setShowAddr

public void setShowAddr(boolean showAddr)

Description copied from interface: PaymentDetailsIf

If set to true, the UI page where credit card details are entered, will display an address field.

Specified by:

setShowAddr in interface PaymentDetailsIf

Parameters:

showAddr - The showAddr to set.

isShowCVV

public boolean isShowCVV()

Description copied from interface: PaymentDetailsIf

If set to true, the UI page where credit card details are entered, will display a CVV field.

Specified by:

isShowCVV in interface PaymentDetailsIf

Returns:

Returns the showCVV.

setShowCVV

public void setShowCVV(boolean showCVV)

Description copied from interface: PaymentDetailsIf

If set to true, the UI page where credit card details are entered, will display a CVV field.

Specified by:

setShowCVV in interface PaymentDetailsIf

Parameters:

showCVV - The showCVV to set.

isShowPostcode

public boolean isShowPostcode()

Description copied from interface: PaymentDetailsIf

If set to true, the UI page where credit card details are entered, will display a postcode field.

Specified by:

isShowPostcode in interface PaymentDetailsIf

Returns:

Returns the showPostcode.

setShowPostcode

public void setShowPostcode(boolean showPostcode)

Description copied from interface: PaymentDetailsIf

If set to true, the UI page where credit card details are entered, will display a postcode field.

Specified by:

setShowPostcode in interface PaymentDetailsIf

Parameters:

showPostcode - The showPostcode to set.

isShowType

public boolean isShowType()

Description copied from interface: PaymentDetailsIf

If set to true, the UI page where credit card details are entered, will display a a credit card type field.

Specified by:

isShowType in interface PaymentDetailsIf

Returns:

Returns the showType.

setShowType

public void setShowType(boolean showType)

Description copied from interface: PaymentDetailsIf

If set to true, the UI page where credit card details are entered, will display a credit card type field.

Specified by:

setShowType in interface PaymentDetailsIf

Parameters:

showType - The showType to set.

getCcExpiryMonth

public java.lang.String getCcExpiryMonth()

Specified by:

getCcExpiryMonth in interface PaymentDetailsIf

Returns:

Returns the ccExpiryMonth.

setCcExpiryMonth

public void setCcExpiryMonth(java.lang.String ccExpiryMonth)

Specified by:

setCcExpiryMonth in interface PaymentDetailsIf

Parameters:

ccExpiryMonth - The ccExpiryMonth to set.

getCcExpiryYear

public java.lang.String getCcExpiryYear()

Specified by:

getCcExpiryYear in interface PaymentDetailsIf

Returns:

Returns the ccExpiryYear.

setCcExpiryYear

public void setCcExpiryYear(java.lang.String ccExpiryYear)

Specified by:

setCcExpiryYear in interface PaymentDetailsIf

Parameters:

ccExpiryYear - The ccExpiryYear to set.

isShowOwner

public boolean isShowOwner()

Description copied from interface: PaymentDetailsIf

If set to true, the UI page where credit card details are entered, will display an owner field to enter the name of the credit card owner.

Specified by:

isShowOwner in interface PaymentDetailsIf

Returns:

Returns the showOwner.

setShowOwner

public void setShowOwner(boolean showOwner)

Description copied from interface: PaymentDetailsIf

If set to true, the UI page where credit card details are entered, will display an owner field to enter the name of the credit card owner.

Specified by:

setShowOwner in interface PaymentDetailsIf

Parameters:

showOwner - The showOwner to set.

getReferrer

public java.lang.String getReferrer()

Description copied from interface: PaymentDetailsIf

Gets the Referrer - sometimes required to be set on an HTTP post.

Specified by:

getReferrer in interface PaymentDetailsIf

Returns:

Returns the referrer.

setReferrer

public void setReferrer(java.lang.String referrer)

Description copied from interface: PaymentDetailsIf

Sets the Referrer - sometimes required to be set on an HTTP post.

Specified by:

setReferrer in interface PaymentDetailsIf

Parameters:

referrer - The referrer to set.

getPreProcessCode

public java.lang.String getPreProcessCode()

Information for framework to indicate that some pre-processing code needs to be run for this Payment Gateway

Specified by:

getPreProcessCode in interface PaymentDetailsIf

Returns:

the preProcessCode

setPreProcessCode

public void setPreProcessCode(java.lang.String preProcessCode)

Information for framework to indicate that some pre-processing code needs to be run for this Payment Gateway

Specified by:

setPreProcessCode in interface PaymentDetailsIf

Parameters:

preProcessCode - the preProcessCode to set

getPaymentDetails

public PaymentDetailsIf[] getPaymentDetails()

Description copied from interface: PaymentDetailsIf

The payment details object may consist of more than one payment details objects. If this array is non-null the payment details are recorded here and not at the top level in the object.

Specified by:

getPaymentDetails in interface PaymentDetailsIf

Returns:

the paymentDetails

setPaymentDetails

public void setPaymentDetails(PaymentDetailsIf[] paymentDetails)

Description copied from interface: PaymentDetailsIf

The payment details object may consist of more than one payment details objects. If this array is non-null the payment details are recorded here and not at the top level in the object.

Specified by:

setPaymentDetails in interface PaymentDetailsIf

Parameters:

paymentDetails - the paymentDetails to set

getSubCode

public java.lang.String getSubCode()

Description copied from interface: PaymentDetailsIf

One PaymentDetails code can have multiple subCodes as well (eg. for GlobalCollect)

Specified by:

getSubCode in interface PaymentDetailsIf

Returns:

the subCode

setSubCode

public void setSubCode(java.lang.String subCode)

Description copied from interface: PaymentDetailsIf

One PaymentDetails code can have multiple subCodes as well (eg. for GlobalCollect)

Specified by:

setSubCode in interface PaymentDetailsIf

Parameters:

subCode - the subCode to set

cloneMainAttributes

public PaymentDetailsIf cloneMainAttributes()

Clones the main attributes of the PaymentDetailsIf object

Returns:

a cloned PaymentDetailsIf object

getSubSortOrder

public int getSubSortOrder()

Description copied from interface: PaymentDetailsIf

Defines the subSortOrder in which the payment gateways are displayed - order first by sortOrder, then by subSortOrder.

Specified by:

getSubSortOrder in interface PaymentDetailsIf

Returns:

the subSortOrder

setSubSortOrder

public void setSubSortOrder(int subSortOrder)

Description copied from interface: PaymentDetailsIf

Defines the subSortOrder in which the payment gateways are displayed - order first by sortOrder, then by subSortOrder.

Specified by:

setSubSortOrder in interface PaymentDetailsIf

Parameters:

subSortOrder - the subSortOrder to set

getCreditCards

public CreditCardIf[] getCreditCards()

Contains a list of available credit cards

Specified by:

getCreditCards in interface PaymentDetailsIf

Returns:

the creditCards

setCreditCards

public void setCreditCards(CreditCardIf[] creditCards)

Contains a list of available credit cards

Specified by:

setCreditCards in interface PaymentDetailsIf

Parameters:

creditCards - the creditCards to set