com.ibm.commerce.inventory.commands

Class GeneratePackSlipCmdImpl

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.inventory.commands.GeneratePackSlipCmdImpl

All Implemented Interfaces:

com.ibm.commerce.command.CacheableECCommand, ECCommand, ECTargetableCommand, TaskCommand, GeneratePackSlipCmd, 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 GeneratePackSlipCmdImpl
extends TaskCommandImpl
implements GeneratePackSlipCmd

This is the default implementation of the GeneratePackSlipCmd task command.

Behavior:

• The pack slip is generated by pick batch for each specified order release.
• The pack slip is organized by all eligible items,which are order,orderItem,ship address and release charge.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COPYRIGHT The IBM Copyright notice field.

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

LOCAL

Fields inherited from interface com.ibm.commerce.inventory.commands.GeneratePackSlipCmd

defaultCommandClassName, NAME

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

serialVersionUID

Constructor Summary

Constructors

Constructor and Description
GeneratePackSlipCmdImpl()

Method Summary

Modifier and Type	Method and Description
java.lang.String	generatePackslip() This method generates the pack slip xml.
java.lang.String	generatePackslip(java.lang.String argPickBatchId, java.lang.String argStoreName, java.lang.String argFfmcenterName, java.lang.String argOrderNumber, java.lang.String argReleaseNumber, java.lang.String argCustomerNumber, java.lang.String argOrderDate) This method generates the pack slip XML for an order release.
void	generateXMLForKitComponent(com.ibm.commerce.order.utils.DynamicKitComponent component, int treeLevel, java.io.PrintWriter output) This method generates the XML for a specified KitComponent node in the Nested Kit tree
void	generateXMLForNestedKit(com.ibm.commerce.order.utils.NestedKitNode rootNode, java.io.PrintWriter output) This method is top-level call to generate XML for the NestedKit tree
void	generateXMLToCloseSubTree(int treeLevel, java.io.PrintWriter output) The method generates XML to close the subtree tags
java.lang.Long	getBaseItemID() This method returns the baseItemID.
java.lang.String	getCustomerNumber() This method returns the customerNumber.
java.lang.Integer	getFfmcenterId() This method returns fulfillment center identifier.
java.lang.String	getFfmcenterName() This method returns the ffmcenterName.
java.lang.Integer	getLanguageId() This method returns language identifier.
java.lang.String	getLongDescription() This method returns the longDescription.
java.lang.String	getOrderDate() This method returns the orderDate.
java.lang.Double	getOrderedQuantity() This method returns the orderedQuantity.
java.lang.String	getOrderItemId() This method returns the orderItemId
java.lang.String	getOrderNumber() This method returns the orderNumber.
java.util.Vector	getOrderReleases() This method returns the Order Releases vector.
java.lang.String	getPackSlipXml() This method returns the packSlipXml.
java.lang.String	getPickBatchId() This method returns the pick batch identifier.
java.util.HashMap	getPickSlipData() This method returns the pack slip data
java.lang.String	getReleaseNumber() This method returns the releaseNumber.
TypedProperty	getRequestProperties() This method returns the ihshRequestProperties.
java.lang.String	getShortDescription() This method returns the shortDescription.
java.lang.String	getSKU() This method returns the sKU.
java.lang.Integer	getStoreentId() This method returns the store entity identifier.
java.lang.String	getStoreName() This method returns the storeName.
void	performExecute() This method performs the main business logic of the command.
void	reset() This method resets command state
void	setBaseItemID(java.lang.Long abaseItemID) This method sets the baseItemID.
void	setCustomerNumber(java.lang.String acustomerNumber) This method sets the customerNumber.
void	setFfmcenterId(java.lang.Integer newFfmcenterId) This method sets fulfillment center identifier.
void	setFfmcenterName(java.lang.String affmcenterName) This method sets the ffmcenterName.
void	setLanguageId(java.lang.Integer newLanguageId) This method sets language identifier.
void	setLongDescription(java.lang.String alongDescription) This method sets the longDescription.
void	setOrderDate(java.lang.String anorderDate) This method sets the orderDate.
void	setOrderedQuantity(java.lang.Double anorderedQuantity) This method sets the orderedQuantity.
void	setOrderNumber(java.lang.String anorderNumber) This method sets the orderNumber.
void	setOrderReleases(java.util.Vector anOrderReleases) This method sets the Vector of Order releases.
void	setPackSlipXml(java.lang.String apackSlipXml) This method sets the packSlipXml.
void	setPickBatchId(java.lang.String newPickBatchId) This method sets the pick batch identifier.
void	setReleaseNumber(java.lang.String areleaseNumber) This method sets the releaseNumber.
void	setRequestProperties(TypedProperty newRequestProperties) This method sets request properties.
void	setShortDescription(java.lang.String ashortDescription) This method sets the shortDescription.
void	setSKU(java.lang.String asKU) This method sets the sKU.
void	setStoreentId(java.lang.Integer newStoreentId) This method sets the store entity identifier.
void	setStoreName(java.lang.String astoreName) This method sets the storeName.
void	traverseNestedKit(com.ibm.commerce.order.utils.NestedKitNode node, int treeLevel, java.io.PrintWriter output) This method is recursive call that traverses through the nodes of the NestedKit tree
void	validateParameters() This method checks the information needed for pick slip generation.

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, isReadyToCallExecute, setAccCheck, setCommandContext, setCommandIfName, setCommandStoreId, setDefaultProperties

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

isReadyToCallExecute

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

Field Detail

COPYRIGHT

public static final java.lang.String COPYRIGHT

The IBM Copyright notice field.

See Also:

Constant Field Values

Constructor Detail

GeneratePackSlipCmdImpl

public GeneratePackSlipCmdImpl()

Method Detail

getFfmcenterId

public java.lang.Integer getFfmcenterId()

This method returns fulfillment center identifier.

Specified by:

getFfmcenterId in interface GeneratePackSlipCmd

Returns:

Fulfillment center id.

See Also:

setFfmcenterId(java.lang.Integer)

getLanguageId

public java.lang.Integer getLanguageId()

This method returns language identifier.

Specified by:

getLanguageId in interface GeneratePackSlipCmd

Returns:

Language id.

See Also:

setLanguageId(java.lang.Integer)

getPickBatchId

public java.lang.String getPickBatchId()

This method returns the pick batch identifier.

Specified by:

getPickBatchId in interface GeneratePackSlipCmd

Returns:

Pick batch id.

See Also:

setPickBatchId(java.lang.String)

getStoreentId

public java.lang.Integer getStoreentId()

This method returns the store entity identifier.

Specified by:

getStoreentId in interface GeneratePackSlipCmd

Returns:

Store entity identifier.

See Also:

setStoreentId(java.lang.Integer)

setFfmcenterId

public void setFfmcenterId(java.lang.Integer newFfmcenterId)

This method sets fulfillment center identifier.

Specified by:

setFfmcenterId in interface GeneratePackSlipCmd

Parameters:

newFfmcenterId - fulfillment center id

See Also:

getFfmcenterId()

setLanguageId

public void setLanguageId(java.lang.Integer newLanguageId)

This method sets language identifier.

Specified by:

setLanguageId in interface GeneratePackSlipCmd

Parameters:

newLanguageId - language id

See Also:

getLanguageId()

setPickBatchId

public void setPickBatchId(java.lang.String newPickBatchId)

This method sets the pick batch identifier.

Specified by:

setPickBatchId in interface GeneratePackSlipCmd

Parameters:

newPickBatchId - pick batch id

See Also:

getPickBatchId()

setStoreentId

public void setStoreentId(java.lang.Integer newStoreentId)

This method sets the store entity identifier.

Specified by:

setStoreentId in interface GeneratePackSlipCmd

Parameters:

newStoreentId - store id

See Also:

getStoreentId()

getPickSlipData

public java.util.HashMap getPickSlipData()

This method returns the pack slip data

Specified by:

getPickSlipData in interface GeneratePackSlipCmd

Returns:

HashMap of pack slip data (PackSlipEntry instances)

setRequestProperties

public void setRequestProperties(TypedProperty newRequestProperties)
                          throws ECApplicationException

This method sets request properties.

Specified by:

setRequestProperties in interface GeneratePackSlipCmd

Parameters:

newRequestProperties - request properties

Throws:

ECApplicationException

validateParameters

public void validateParameters()
                        throws ECException

This method checks the information needed for pick slip generation.

StoreId and language id must be set in the command context.

Also checking that fulfillment center id is not null.

Specified by:

validateParameters in interface ECCommand

Overrides:

validateParameters in class AbstractECTargetableCommand

Throws:

ECException - If mandatory parameters are not set, throw ECApplicationException.

getOrderReleases

public java.util.Vector getOrderReleases()

This method returns the Order Releases vector.

Specified by:

getOrderReleases in interface GeneratePackSlipCmd

Returns:

Order Releases.

See Also:

setOrderReleases(java.util.Vector)

setOrderReleases

public void setOrderReleases(java.util.Vector anOrderReleases)

This method sets the Vector of Order releases.

Specified by:

setOrderReleases in interface GeneratePackSlipCmd

Parameters:

vecOrderReleases -

See Also:

getOrderReleases()

reset

public void reset()

This method resets command state

Specified by:

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

Overrides:

reset in class AbstractECTargetableCommand

performExecute

public void performExecute()
                    throws ECException

This method 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

generatePackslip

public java.lang.String generatePackslip(java.lang.String argPickBatchId,
                                         java.lang.String argStoreName,
                                         java.lang.String argFfmcenterName,
                                         java.lang.String argOrderNumber,
                                         java.lang.String argReleaseNumber,
                                         java.lang.String argCustomerNumber,
                                         java.lang.String argOrderDate)
                                  throws ECException

This method generates the pack slip XML for an order release.

• Uses OrderItemAccessBean and OrderAccessBean to check if InvoiceTC exists in Terms and Condition table. Proceed only if InvoiceTC is present.
• Then uses TradingAgreementAccessBean and InvoiceTCAccessBean to get the invoice delivery method.
• Gets shipping provider. Use InventoryJDBCHelperAccessBean() .findReleaseShipmodeIdByOrdersIdAndOrdreleaseNum to get the ship mode id.
• Gets the shipping provider name using ShippingModeDescriptionAccessBean.
• Gets ship to address using InventoryJDBCHelperAccessBean() .findReleaseAddressIdByOrdersIdAndOrdreleaseNum.
• Creates the XML output.
• Gets the list of order items, using InventoryJDBCHelperAccessBean() .findPackslipItemsListByOrdersIdAndOrdreleaseNum.
• Uses BaseItemDescriptionAccessBean to get the product description.
• Uses CatalogEntryDescriptionAccessBean to get the catalog entry description.
• Gets the component list for a dynamic or static kit using InventoryJDBCHelperAccessBean() .findPackslipComponentsListByOrderItemsId.
• Finalizes the XML output.

Parameters:

argPickBatchId - pick batch identifier

argStoreName - store entity name

argFfmcenterName - fulfillment center name

argOrderNumber - order number

argReleaseNumber - release number

argCustomerNumber - customer number

argOrderDate - order date

Returns:

Pack slip XML for an order release.

Throws:

ECException -

• ECSystemException Naming error, _ERR_CREATE_EXCEPTION
• ECSystemException Finder error, _ERR_FINDER_EXCEPTION
• ECSystemException Naming error, _ERR_NAMING_EXCEPTION
• ECSystemException Remote error, _ERR_REMOTE_EXCEPTION

generatePackslip

public java.lang.String generatePackslip()
                                  throws ECException

This method generates the pack slip xml.

Returns:

the pack slip xml as a string

Throws:

ECException - for failures

getFfmcenterName

public java.lang.String getFfmcenterName()

This method returns the ffmcenterName.

Returns:

String

getStoreName

public java.lang.String getStoreName()

This method returns the storeName.

Returns:

String

setFfmcenterName

public void setFfmcenterName(java.lang.String affmcenterName)

This method sets the ffmcenterName.

Parameters:

affmcenterName - the ffmcenterName to set

setStoreName

public void setStoreName(java.lang.String astoreName)

This method sets the storeName.

Parameters:

astoreName - the storeName to set

getRequestProperties

public TypedProperty getRequestProperties()

This method returns the ihshRequestProperties.

Returns:

TypedProperty

getCustomerNumber

public java.lang.String getCustomerNumber()

This method returns the customerNumber.

Returns:

String

getOrderDate

public java.lang.String getOrderDate()

This method returns the orderDate.

Returns:

String

getOrderNumber

public java.lang.String getOrderNumber()

This method returns the orderNumber.

Specified by:

getOrderNumber in interface GeneratePackSlipCmd

Returns:

String

See Also:

GeneratePackSlipCmd.setOrderNumber(java.lang.String)

getPackSlipXml

public java.lang.String getPackSlipXml()

This method returns the packSlipXml.

Specified by:

getPackSlipXml in interface GeneratePackSlipCmd

Returns:

String

See Also:

GeneratePackSlipCmd.setPackSlipXml(java.lang.String)

getReleaseNumber

public java.lang.String getReleaseNumber()

This method returns the releaseNumber.

Specified by:

getReleaseNumber in interface GeneratePackSlipCmd

Returns:

String

setCustomerNumber

public void setCustomerNumber(java.lang.String acustomerNumber)

This method sets the customerNumber.

Parameters:

acustomerNumber - the customerNumber to set

setOrderDate

public void setOrderDate(java.lang.String anorderDate)

This method sets the orderDate.

Parameters:

anorderDate - the orderDate to set

setOrderNumber

public void setOrderNumber(java.lang.String anorderNumber)

This method sets the orderNumber.

Specified by:

setOrderNumber in interface GeneratePackSlipCmd

Parameters:

anorderNumber - the orderNumber to set

See Also:

GeneratePackSlipCmd.getOrderNumber()

setPackSlipXml

public void setPackSlipXml(java.lang.String apackSlipXml)

This method sets the packSlipXml.

Specified by:

setPackSlipXml in interface GeneratePackSlipCmd

Parameters:

apackSlipXml - the packSlipXml to set

See Also:

GeneratePackSlipCmd.getPackSlipXml()

setReleaseNumber

public void setReleaseNumber(java.lang.String areleaseNumber)

This method sets the releaseNumber.

Parameters:

areleaseNumber - the releaseNumber to set

getBaseItemID

public java.lang.Long getBaseItemID()

This method returns the baseItemID.

Specified by:

getBaseItemID in interface GeneratePackSlipCmd

Returns:

Long

getOrderedQuantity

public java.lang.Double getOrderedQuantity()

This method returns the orderedQuantity.

Specified by:

getOrderedQuantity in interface GeneratePackSlipCmd

Returns:

Double

setBaseItemID

public void setBaseItemID(java.lang.Long abaseItemID)

This method sets the baseItemID.

Parameters:

abaseItemID - the baseItemID to set

setOrderedQuantity

public void setOrderedQuantity(java.lang.Double anorderedQuantity)

This method sets the orderedQuantity.

Parameters:

anorderedQuantity - the orderedQuantity to set

getSKU

public java.lang.String getSKU()

This method returns the sKU.

Specified by:

getSKU in interface GeneratePackSlipCmd

Returns:

String

See Also:

GeneratePackSlipCmd.setSKU(java.lang.String)

setSKU

public void setSKU(java.lang.String asKU)

This method sets the sKU.

Specified by:

setSKU in interface GeneratePackSlipCmd

Parameters:

asKU - the sKU to set

See Also:

GeneratePackSlipCmd.getSKU()

getLongDescription

public java.lang.String getLongDescription()

This method returns the longDescription.

Specified by:

getLongDescription in interface GeneratePackSlipCmd

Returns:

String

getShortDescription

public java.lang.String getShortDescription()

This method returns the shortDescription.

Specified by:

getShortDescription in interface GeneratePackSlipCmd

Returns:

String

getOrderItemId

public java.lang.String getOrderItemId()

This method returns the orderItemId

Returns:

orderItemId

setLongDescription

public void setLongDescription(java.lang.String alongDescription)

This method sets the longDescription.

Parameters:

alongDescription - the longDescription to set

setShortDescription

public void setShortDescription(java.lang.String ashortDescription)

This method sets the shortDescription.

Parameters:

ashortDescription - the shortDescription to set

generateXMLForNestedKit

public void generateXMLForNestedKit(com.ibm.commerce.order.utils.NestedKitNode rootNode,
                                    java.io.PrintWriter output)
                             throws ECException

This method is top-level call to generate XML for the NestedKit tree

Parameters:

rootNode - instance of NestedKitNode class

output - instance of PrintWriter class

Throws:

ECException

traverseNestedKit

public void traverseNestedKit(com.ibm.commerce.order.utils.NestedKitNode node,
                              int treeLevel,
                              java.io.PrintWriter output)
                       throws ECException

This method is recursive call that traverses through the nodes of the NestedKit tree

Parameters:

node - instance of NestedKitNode class

treeLevel - the Integer number

output - instance of PrintWriter class

Throws:

ECException

generateXMLForKitComponent

public void generateXMLForKitComponent(com.ibm.commerce.order.utils.DynamicKitComponent component,
                                       int treeLevel,
                                       java.io.PrintWriter output)
                                throws ECException

This method generates the XML for a specified KitComponent node in the Nested Kit tree

Parameters:

component - instance of DynamicKitComponent class

treeLevel - the Integer number

output - instance of PrintWriter class

Throws:

ECException

generateXMLToCloseSubTree

public void generateXMLToCloseSubTree(int treeLevel,
                                      java.io.PrintWriter output)

The method generates XML to close the subtree tags

Parameters:

treeLevel - the Integer number

output - instance of PrintWriter class