com.ibm.commerce.payment.commands

Class PrepareInvoiceCmdImpl

java.lang.Object

com.ibm.websphere.command.TargetableCommandImpl

com.ibm.websphere.command.CacheableCommandImpl

com.ibm.commerce.command.MeasuredCacheableCommandImpl

com.ibm.commerce.command.AbstractECTargetableCommand

com.ibm.commerce.command.TaskCommandImpl

com.ibm.commerce.payment.commands.PrepareInvoiceCmdImpl

All Implemented Interfaces:

com.ibm.commerce.command.CacheableECCommand, ECCommand, ECTargetableCommand, TaskCommand, PrepareInvoiceCmd, com.ibm.websphere.cache.Sizeable, com.ibm.websphere.command.CacheableCommand, com.ibm.websphere.command.Command, com.ibm.websphere.command.CommandCaller, com.ibm.websphere.command.TargetableCommand, java.io.Serializable

public class PrepareInvoiceCmdImpl
extends TaskCommandImpl
implements PrepareInvoiceCmd

This PrepareInvoiceCmd Task Command implementation class prepares an invoice for an order release in the form of an XML String. Stores the String in the WebSphere Commerce database. And sends the Invoice to the Buyer Contact of the Account in the form of an eMail. If the Account has an Invoice Terms and Conditions that specify a delivery method using eMail.

This command uses the following AccessBeans:

• AddressAccessBean
• BusinessPolicyAccessBean
• InvoiceAccessBean
• InvoiceTCAccessBean
• LanguageAccessBean
• OrderAccessBean
• OrderItemAccessBean
• ParticipantAccessBean
• TradingAgreementAccessBean
• TermConditionAccessBean
• StoreAccessBean
• UserAccessBean

This command does not call other TaskCommand.

See Also:

Serialized Form

Field Summary

Fields inherited from class com.ibm.websphere.command.TargetableCommandImpl

LOCAL

Fields inherited from interface com.ibm.commerce.payment.commands.PrepareInvoiceCmd

defaultCommandClassName, NAME

Fields inherited from interface com.ibm.websphere.command.Command

serialVersionUID

Constructor Summary

Constructors

Constructor and Description
PrepareInvoiceCmdImpl()

Method Summary

Modifier and Type	Method and Description
boolean	isReadyToCallExecute() This method is called by the Command Framework to check if all basic mandatory parameters have been set for this command.
void	performExecute() Performs the main business logic of the command.
void	reset() Resets the instance variables of the command.
void	setOrderId(java.lang.Long aOrderId) Sets the orderId property of the command.
void	setOrderReleaseNum(java.lang.Integer newOrderReleaseNum) Sets the orderReleaseNum property of the command.

Methods inherited from class com.ibm.commerce.command.AbstractECTargetableCommand

accessControlCheck, checkIsAllowed, checkResourcePermission, createCommandExecutionEvent, execute, getAccCheck, getCommandContext, getCommandIfName, getCommandName, getCommandStoreId, getDefaultProperties, getExceptionInvokeParameters, getObjectSize, getPostInvokeParameters, getPreInvokeParameters, getResources, getStoreId, getUser, getUserId, setAccCheck, setCommandContext, setCommandIfName, setCommandStoreId, setDefaultProperties, validateParameters

Methods inherited from class com.ibm.websphere.command.CacheableCommandImpl

executeFromCache, getCaller, getEntryInfo, getId, getSharingPolicy, postExecute, preExecute, setCaller, setObjectSize, unionDependencies, updateCache

Methods inherited from class com.ibm.websphere.command.TargetableCommandImpl

getCommandTarget, getCommandTargetName, getTargetPolicy, hasOutputProperties, setCommandTarget, setCommandTargetName, setHasOutputProperties, setOutputProperties, setTargetPolicy

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.ibm.commerce.command.CacheableECCommand

execute

Methods inherited from interface com.ibm.websphere.command.CacheableCommand

executeFromCache, getCaller, getEntryInfo, getId, getSharingPolicy, postExecute, preExecute, setCaller, updateCache

Methods inherited from interface com.ibm.websphere.command.TargetableCommand

getCommandTarget, getCommandTargetName, hasOutputProperties, setCommandTarget, setCommandTargetName, setOutputProperties

Methods inherited from interface com.ibm.websphere.command.CommandCaller

unionDependencies

Methods inherited from interface com.ibm.commerce.command.ECCommand

checkIsAllowed, checkResourcePermission, createCommandExecutionEvent, getAccCheck, getCommandContext, getCommandIfName, getCommandName, getCommandStoreId, getDefaultProperties, getExceptionInvokeParameters, getPostInvokeParameters, getPreInvokeParameters, getResources, getStoreId, getUser, getUserId, setAccCheck, setCommandContext, setCommandIfName, setCommandStoreId, setDefaultProperties, validateParameters

Constructor Detail

PrepareInvoiceCmdImpl

public PrepareInvoiceCmdImpl()

Method Detail

isReadyToCallExecute

public boolean isReadyToCallExecute()

This method is called by the Command Framework to check if all basic mandatory parameters have been set for this command. This is done before the Framework calls the performExecute method of the command.

Specified by:

isReadyToCallExecute in interface com.ibm.websphere.command.Command

Overrides:

isReadyToCallExecute in class AbstractECTargetableCommand

Returns:

true if we can execute the command; false otherwise.

performExecute

public void performExecute()
                    throws ECException

Performs the main business logic of the command.

Specified by:

performExecute in interface ECCommand

Specified by:

performExecute in interface com.ibm.websphere.command.TargetableCommand

Overrides:

performExecute in class AbstractECTargetableCommand

Throws:

ECException

reset

public void reset()

Resets the instance variables of the command. The reset() method will reset all instance variables. If the command includes any output values that are accessible via getters. Then make sure those values are no longer needed before calling this method to reset the instance variables of the command.

This is useful if the command instance is to be called multiple times with different command parameters.

Specified by:

reset in interface com.ibm.websphere.command.Command

Overrides:

reset in class AbstractECTargetableCommand

setOrderId

public void setOrderId(java.lang.Long aOrderId)

Sets the orderId property of the command.

Specified by:

setOrderId in interface PrepareInvoiceCmd

Parameters:

aOrderId - the ID of the order for which an invoice is to be prepared.

setOrderReleaseNum

public void setOrderReleaseNum(java.lang.Integer newOrderReleaseNum)

Sets the orderReleaseNum property of the command.

Specified by:

setOrderReleaseNum in interface PrepareInvoiceCmd

Parameters:

newOrderReleaseNum - the release number of the Order Release for which an invoice is to be prepared.