java.lang.Object | +--CacheableCommandImpl | +--com.ibm.commerce.command.AbstractECTargetableCommand | +--com.ibm.commerce.command.TaskCommandImpl | +--com.ibm.commerce.payment.commands.PrepareInvoiceCmdImpl
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.
Field Summary |
---|
Fields inherited from class com.ibm.commerce.command. AbstractECTargetableCommand |
commandContext |
Fields inherited from interface com.ibm.commerce.payment.commands. PrepareInvoiceCmd |
COPYRIGHT,
defaultCommandClassName,
NAME |
Fields inherited from interface com.ibm.commerce.command. ECTargetableCommand |
COPYRIGHT |
Fields inherited from interface com.ibm.commerce.command. ECCommand |
defaultCommandClassName |
Constructor Summary | |
---|---|
PrepareInvoiceCmdImpl() |
Method Summary | |
---|---|
protected
java.sql.Timestamp |
getInvoiceDate() Returns the date for the invoice. |
protected
java.lang.String |
getInvoiceId() Returns the internal ID of the invoice record. |
protected
OrderAccessBean |
getOrder() Returns the OrderAccessBean representing the order. |
protected
java.lang.Long |
getOrderId() Returns the ID of the order for which the Invoice is to be prepared. |
protected
java.lang.Integer |
getOrderReleaseNum() Returns the Release Number of this Order Release for which the Invoice is to be prepared. |
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. |
protected
void |
setInvoiceDate(java.sql.Timestamp newInvoiceDate) Sets the date of the invoice. |
protected
void |
setInvoiceId(java.lang.String newInvoiceId) Sets the invoiceId property 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,
checkParameters,
checkResourcePermission,
createCommandExecutionEvent,
execute,
finalize,
getAccCheck,
getCommandContext,
getCommandIfName,
getCommandName,
getCommandStoreId,
getDefaultProperties,
getResources,
getStoreId,
getUser,
getUserId,
setAccCheck,
setCommandContext,
setCommandIfName,
setCommandStoreId,
setDefaultProperties,
validateParameters |
Methods inherited from class java.lang.Object |
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait,
wait, wait |
Constructor Detail |
---|
public PrepareInvoiceCmdImpl()
Method Detail |
---|
protected java.sql.Timestamp getInvoiceDate()
protected java.lang.String getInvoiceId()
protected OrderAccessBean getOrder()
protected java.lang.Long getOrderId()
protected java.lang.Integer getOrderReleaseNum()
public boolean isReadyToCallExecute()
isReadyToCallExecute
in class
AbstractECTargetableCommand
public void performExecute() throws ECException
performExecute
in interface
ECCommand
performExecute
in class
AbstractECTargetableCommand
ECException
public void reset()
This is useful if the command instance is to be called multiple times with different command parameters.
reset
in class
AbstractECTargetableCommand
protected void setInvoiceDate(java.sql.Timestamp newInvoiceDate)
newInvoiceDate
- the invoice dateprotected void setInvoiceId(java.lang.String newInvoiceId)
newInvoiceId
- the invoice IDpublic void setOrderId(java.lang.Long aOrderId)
setOrderId
in interface
PrepareInvoiceCmd
aOrderId
- The order reference number of the Order for which
an Invoice is to be prepared.public void setOrderReleaseNum(java.lang.Integer newOrderReleaseNum)
setOrderReleaseNum
in interface
PrepareInvoiceCmd
newOrderReleaseNum
- The order release reference number of the
Order for which an Invoice is to be prepared.