com.konakart.json.app
Class J_PaymentDetails

java.lang.Object
  com.konakart.json.app.J_PaymentDetails

All Implemented Interfaces:

java.io.Serializable

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

An order may have a PaymentDetails object to describe the payment method. This object is generated by a payment module.

Payment modules may be enabled and disabled using the KonaKart Admin App so that you can control the payment methods that can be used by your application.

See Also:

Serialized Form

Constructor Summary

J_PaymentDetails()

Method Summary

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.
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()
J_NameValue[]	getParameters() An array of name value pairs which are the parameters that will be posted to the payment gateway.
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	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	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(J_NameValue[] _parameters) An array of name value pairs which are the parameters that will be posted to the payment gateway.
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.
void	setTitle(java.lang.String _title) The title of the payment gateway which can be used in the UI.

Methods inherited from class java.lang.Object

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

Constructor Detail

J_PaymentDetails

public J_PaymentDetails()

Method Detail

getParameters

public J_NameValue[] getParameters()

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

Returns:

Returns the parameters.

setParameters

public void setParameters(J_NameValue[] _parameters)

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

Parameters:

_parameters - The parameters to set.

getReferrer

public java.lang.String getReferrer()

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

Returns:

Returns the Referrer.

setReferrer

public void setReferrer(java.lang.String _referrer)

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

Parameters:

_referrer - the Referrer to set

getPostOrGet

public java.lang.String getPostOrGet()

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

Returns:

Returns the postOrGet.

setPostOrGet

public void setPostOrGet(java.lang.String _postOrGet)

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

Parameters:

_postOrGet - The postOrGet to set.

getRequestUrl

public java.lang.String getRequestUrl()

The payment gateway url.

Returns:

Returns the requestUrl.

setRequestUrl

public void setRequestUrl(java.lang.String _requestUrl)

The payment gateway url.

Parameters:

_requestUrl - The requestUrl to set.

getCode

public java.lang.String getCode()

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

Returns:

Returns the code.

setCode

public void setCode(java.lang.String _code)

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

Parameters:

_code - The code to set.

getDescription

public java.lang.String getDescription()

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

Returns:

Returns the description.

setDescription

public void setDescription(java.lang.String _description)

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

Parameters:

_description - The description to set.

getSortOrder

public int getSortOrder()

Defines the order in which the payment gateways are displayed.

Returns:

Returns the sortOrder.

setSortOrder

public void setSortOrder(int _sortOrder)

Defines the order in which the payment gateways are displayed.

Parameters:

_sortOrder - The sortOrder to set.

getTitle

public java.lang.String getTitle()

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

Returns:

Returns the title.

setTitle

public void setTitle(java.lang.String _title)

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

Parameters:

_title - The title to set.

getOrderStatusId

public int getOrderStatusId()

Returns:

Returns the orderStatusId.

setOrderStatusId

public void setOrderStatusId(int _orderStatusId)

Parameters:

_orderStatusId - The orderStatusId to set.

getPaymentType

public 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. 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. authorizenet, usaepay

Returns:

Returns the paymentType.

setPaymentType

public 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. 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. authorizenet, usaepay

Parameters:

_paymentType - The paymentType to set.

getCcNumber

public java.lang.String getCcNumber()

Returns:

Returns the ccNumber.

setCcNumber

public void setCcNumber(java.lang.String _ccNumber)

Parameters:

_ccNumber - The ccNumber to set.

getCcPostcode

public java.lang.String getCcPostcode()

Returns:

Returns the ccPostcode.

setCcPostcode

public void setCcPostcode(java.lang.String _ccPostcode)

Parameters:

_ccPostcode - The ccPostcode to set.

getCcStreetAddress

public java.lang.String getCcStreetAddress()

Returns:

Returns the ccStreetAddress.

setCcStreetAddress

public void setCcStreetAddress(java.lang.String _ccStreetAddress)

Parameters:

_ccStreetAddress - The ccStreetAddress to set.

getCustom1

public java.lang.String getCustom1()

Returns:

Returns the custom1.

setCustom1

public void setCustom1(java.lang.String _custom1)

Parameters:

_custom1 - The custom1 to set.

getCustom2

public java.lang.String getCustom2()

Returns:

Returns the custom2.

setCustom2

public void setCustom2(java.lang.String _custom2)

Parameters:

_custom2 - The custom2 to set.

getCustom3

public java.lang.String getCustom3()

Returns:

Returns the custom3.

setCustom3

public void setCustom3(java.lang.String _custom3)

Parameters:

_custom3 - The custom3 to set.

getCustom4

public java.lang.String getCustom4()

Returns:

Returns the custom4.

setCustom4

public void setCustom4(java.lang.String _custom4)

Parameters:

_custom4 - The custom4 to set.

getCustom5

public java.lang.String getCustom5()

Returns:

Returns the custom5.

setCustom5

public void setCustom5(java.lang.String _custom5)

Parameters:

_custom5 - The custom5 to set.

getCcCVV

public java.lang.String getCcCVV()

Returns:

Returns the ccCVV.

setCcCVV

public void setCcCVV(java.lang.String _ccCVV)

Parameters:

_ccCVV - The ccCVV to set.

getCcOwner

public java.lang.String getCcOwner()

Returns:

Returns the ccOwner.

setCcOwner

public void setCcOwner(java.lang.String _ccOwner)

Parameters:

_ccOwner - The ccOwner to set.

getCcType

public java.lang.String getCcType()

Returns:

Returns the ccType.

setCcType

public void setCcType(java.lang.String _ccType)

Parameters:

_ccType - The ccType to set.

isShowAddr

public boolean isShowAddr()

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

Returns:

Returns the showAddr.

setShowAddr

public void setShowAddr(boolean _showAddr)

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

Parameters:

_showAddr - The showAddr to set.

isShowCVV

public boolean isShowCVV()

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

Returns:

Returns the showCVV.

setShowCVV

public void setShowCVV(boolean _showCVV)

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

Parameters:

_showCVV - The showCVV to set.

isShowPostcode

public boolean isShowPostcode()

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

Returns:

Returns the showPostcode.

setShowPostcode

public void setShowPostcode(boolean _showPostcode)

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

Parameters:

_showPostcode - The showPostcode to set.

isShowType

public boolean isShowType()

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

Returns:

Returns the showType.

setShowType

public void setShowType(boolean _showType)

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

Parameters:

_showType - The showType to set.

getCcExpiryMonth

public java.lang.String getCcExpiryMonth()

Returns:

Returns the ccExpiryMonth.

setCcExpiryMonth

public void setCcExpiryMonth(java.lang.String _ccExpiryMonth)

Parameters:

_ccExpiryMonth - The ccExpiryMonth to set.

getCcExpiryYear

public java.lang.String getCcExpiryYear()

Returns:

Returns the ccExpiryYear.

setCcExpiryYear

public void setCcExpiryYear(java.lang.String _ccExpiryYear)

Parameters:

_ccExpiryYear - The ccExpiryYear to set.

isShowOwner

public 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.

Returns:

Returns the showOwner.

setShowOwner

public 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.

Parameters:

_showOwner - The showOwner 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

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

Parameters:

_preProcessCode - the preProcessCode to set