Overview

Package

PrevClass

Class

NextClass

Tree

Deprecated

Index Help

Frames NoFrames

Summary:Nested|Field|Constr|Method

AllClasses

Detail:Field|Constr|Method

com.ibm.commerce.edp.commands

InterfacePrimePaymentCmd
AllSuperinterfaces:
AEDPPaymentTaskCmd,AEDPStoreTaskCmd,AEDPTaskCmd,
com.ibm.websphere.command.CacheableCommand,
com.ibm.commerce.command.CacheableECCommand,com.ibm.websphere.command.Command,
com.ibm.websphere.command.CommandCaller,ECCommand,java.io.Serializable,
com.ibm.websphere.command.TargetableCommand,TaskCommand

AllKnownImplementingClasses:
PrimePaymentCmdImpl,PrimePaymentVoidCmdImpl

publicinterfacePrimePaymentCmd
extendsAEDPStoreTaskCmd
Thistaskcommandisusedtopreparepaymentsinthepaymentsrulessubcomponent.It'sinvokedbythe
ProcessOrderCmdImplControllerCommandtopreparepaymentprocessingforanorder.ThereturnDatamaybenull.In
thiscase,OrderProcessCmdwillgototheOrderOKViewtodisplayaconfirmationpagetothecustomer.
Thiscommandiscalledbytheordercapture.Whentheorderiscaptured,thiscommandprovidessomeguarantee
thatthecustomerhasfundstopayfortheorder.LiketheStoreAndValidatePaymentCmd,thepurposeofthiscommandis
forthemerchanttofindoutwhetherapaymentisbadbeforethecustomerisdisengaged.APaymentRulesorder
andpaymentinstructionscanbecreatedbythiscommand.APaymentRulesordercorrespondstothepayment
portionofaWebSphereCommerceorder,andcanhavemultiplereleasesassociatedwithit.Butnormallythe
PaymentRulesorderiscreatedbyStoreAndValidatePaymentCmdandthepaymentinstructionsareaddedbyPIAddCmd.
DuringPrimePaymentCmd,Ifthecurrentchargeoftheorderiszero.Thentheuserhastheconfigurationtoeithervalidate
paymentorapprovetheminimumamountordonothing.
ThePrimePaymentCmdisnotoptionalitalwaysoccurs.
TwologicsofthePrimePaymentCmdexist:onewithpaymentinstructions,andonewithoutpaymentinstructions.The
followingconditionsapplytoeach:
Whenthecommandiscalledwithpaymentinstructions,eachpaymentinstructionisvalidatedandadded.
Whenthecommandiscalledwithoutpaymentinstructions,novalidationtakesplaceandnopayment
instructionisadded.ThislogicoccurswhentheStoreAndValidatePaymentCmdandPIAddCmdhasalreadycalled.
Thepossiblepaymentactionsassociatedwiththiscommandare:Validation,Approve,andDeposit.
Forexample,acustomershopsatastore,submitsanorderandspecifiesthataparticularcreditcardshouldbeused
asthepaymentmethod.
APrimePaymentCmdiscalledandthePaymentrulesarereadtodeterminewhatpaymentactionsshouldtakeplacefor
thepaymentmethod.Paymentactionsareconfigurable.Forexample,forcreditcards,thedefaultbehavioristocheck
toensurethatthecustomerhassufficientcreditandthecardhasnotexpired.Ifthecreditcardisfine,thepaymentis
approved.Ifapaymentactionwiththepaymentbackendsystemfails,atickleriscreatedtonotifyaCustomerService
Representative.Otherscenariosmightinvolveotheractions,suchasdepositingthefundsimmediately.
ThedefaultimplementationofthiscommandisPrimePaymentCmdImpl.

SeeAlso:
ProcessOrderCmdImpl,OrderProcessCmd

FieldSummary
Fields
ModifierandType

FieldandDescription

staticjava.lang.String COPYRIGHT
TheIBMCopyrightnoticefield.
staticjava.lang.String defaultCommandClassName
Thedefaultimplementationofthiscommand.
staticjava.lang.String NAME
Thefullnameofthiscommand.

Fieldsinheritedfrominterfacecom.ibm.websphere.command.Command
serialVersionUID

MethodSummary
Methods
ModifierandType

MethodandDescription

java.lang.String

getEDPWarning()
Thismethodreturnsthepaymentsruleswarningmessage.

java.util.Map

getErrorMessageMap()
Thismethodreturnsthemapcontainingerrormessageofeach
PaymentInstruction.

TypedProperty

getPaymentAttributes()
Thismethodobtainsthetaskcommandproperties.

void

setInitialAmount(java.math.BigDecimalinitialAmount)
Thismethodsetstheinitialamounttobeusedintheprime
paymenteventrequest.

void

setPaymentAttributes(TypedPropertyrequestProperties)
Thismethodsetsthepaymentattributespropertyofthe
command.

void

setPaymentMethodId(java.lang.StringpaymentMethodId)
ThismethodsetsthepaymentmethodID.

void

setTotalAmount(java.math.BigDecimaltotalAmount)
Thismethodsetsthetotalamountoftheorder.

Methodsinheritedfrominterface
com.ibm.commerce.edp.commands.AEDPTaskCmd
getCurrency,getEDPResults,getLanguageId,getLocale,getOrderChannel,getOrderId,setEDPResults,setOrderId

Methodsinheritedfrominterface
com.ibm.commerce.command.CacheableECCommand
execute

Methodsinheritedfrominterface
com.ibm.websphere.command.CacheableCommand
executeFromCache,getCaller,getEntryInfo,getId,getSharingPolicy,postExecute,preExecute,setCaller,
updateCache

Methodsinheritedfrominterface
com.ibm.websphere.command.TargetableCommand
getCommandTarget,getCommandTargetName,hasOutputProperties,performExecute,setCommandTarget,
setCommandTargetName,setOutputProperties

Methodsinheritedfrominterface
com.ibm.websphere.command.Command
isReadyToCallExecute,reset

Methodsinheritedfrominterface
com.ibm.websphere.command.CommandCaller
unionDependencies

Methodsinheritedfrominterface
com.ibm.commerce.command.ECCommand
checkIsAllowed,checkResourcePermission,createCommandExecutionEvent,getAccCheck,getCommandContext,
getCommandIfName,getCommandName,getCommandStoreId,getDefaultProperties,getExceptionInvokeParameters,
getPostInvokeParameters,getPreInvokeParameters,getResources,getStoreId,getUser,getUserId,
performExecute,setAccCheck,setCommandContext,setCommandIfName,setCommandStoreId,setDefaultProperties,
validateParameters

FieldDetail
COPYRIGHT
staticfinaljava.lang.StringCOPYRIGHT
TheIBMCopyrightnoticefield.

SeeAlso:
ConstantFieldValues

NAME
staticfinaljava.lang.StringNAME
Thefullnameofthiscommand.

SeeAlso:
ConstantFieldValues

defaultCommandClassName
staticfinaljava.lang.StringdefaultCommandClassName
Thedefaultimplementationofthiscommand.

SeeAlso:
ConstantFieldValues

MethodDetail
getEDPWarning
java.lang.StringgetEDPWarning()
Thismethodreturnsthepaymentsruleswarningmessage.

Returns:
AStringthatspecifiesthepaymentsruleswarningmessage.

setInitialAmount
voidsetInitialAmount(java.math.BigDecimalinitialAmount)
Thismethodsetstheinitialamounttobeusedintheprimepaymenteventrequest.

Parameters:
initialAmountABigDecimalthatspecifiestheinitialamounttobeusedintheprimepaymentevent

request.

setPaymentAttributes
voidsetPaymentAttributes(TypedPropertyrequestProperties)
Thismethodsetsthepaymentattributespropertyofthecommand.

Parameters:
requestPropertiesATypedPropertythatrepresentstherequestPropertiesobjectthatcontainsall

thecommandparametersthataretobepassedtothiscommand.

getPaymentAttributes
TypedPropertygetPaymentAttributes()
Thismethodobtainsthetaskcommandproperties.

Returns:
ATypedPropertythatrepresentsthetaskcommandproperties.

setPaymentMethodId
voidsetPaymentMethodId(java.lang.StringpaymentMethodId)
ThismethodsetsthepaymentmethodID.

Parameters:
paymentMethodIdAStringthatspecifiesthepaymentmethodid.

setTotalAmount
voidsetTotalAmount(java.math.BigDecimaltotalAmount)
Thismethodsetsthetotalamountoftheorder.

Parameters:
totalAmountABigDecimalthatspecifiesthetotalamountoftheorder.

getErrorMessageMap
java.util.MapgetErrorMessageMap()
ThismethodreturnsthemapcontainingerrormessageofeachPaymentInstruction.

Returns:
themapcontainingerrormessageofeachPaymentInstruction

Overview
PrevClass

Package

Class

NextClass

Tree

Deprecated

Frames NoFrames

Summary:Nested|Field|Constr|Method

Index Help
AllClasses

Detail:Field|Constr|Method