com.ibm.commerce.requisitionlist.commands

Class RequisitionListSubmitCmdImpl

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

com.ibm.commerce.requisitionlist.commands.RequisitionListBaseCmdImpl

com.ibm.commerce.requisitionlist.commands.RequisitionListSubmitCmdImpl

All Implemented Interfaces:

AccCommand, ControllerCommand, ECCommand, ECTargetableCommand, RequisitionListSubmitCmd, Protectable, 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 RequisitionListSubmitCmdImpl
extends RequisitionListBaseCmdImpl
implements RequisitionListSubmitCmd

This is the default implementation of the RequisitionListSubmitCmd controller command.

Input parameters:

Name	Type	Requirement	Description
requisitionListId	Long	mandatory	The id of the requisition list to be submitted.
contractId	Long[]	optional	An array of contract ids for price calculation.
offerId	Long[]	optional	An array of offer ids for price calculation.

Output parameters:

Name	Type	Description
orderId	Long	the created pending order list id

Behavior:

• Copy the requisition list and create a new pending order.
• If the contractId or offerId is specified, they will be used to calculate the price for all order items created.
• Call OrderPrepare to prepare the order.

View:

• RedirectView.

This command calls the following TaskCommands:

• OrderItemAddCmd
• OrderPrepareCmd

This command uses the following AccessBeans:

• OrderAccessBean

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.requisitionlist.commands.RequisitionListSubmitCmd

defaultCommandClassName, NAME

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

serialVersionUID

Constructor Summary

Constructors

Constructor and Description
RequisitionListSubmitCmdImpl()

Method Summary

Modifier and Type	Method and Description
void	addOrderItemNVPs(TypedProperty req, OrderItemAccessBean orderItemAB, int i) This method adds some name value pairs to the request properties based on the columns in the orderItamAB.
java.lang.String	getMergeToCurrentPendingOrder() This method returns the indicator to represent whether the requisition list is to be merged into current pending order.
java.lang.Long	getOrderId() This method returns the order id.
AccessVector	getResources() This method returns the store access bean and the order access bean.
void	performExecute() This method is the main execution of the command.
void	setContractId(java.lang.Long[] id) This method specifies an array of contract ids for price calculation.
void	setMergeToCurrentPendingOrder(java.lang.String flag) This method sets the indicator to represent whether the requisition list is to be merged into current pending order.
void	setOfferId(java.lang.Long[] id) This method specifies an array of offer ids for price calculation.
void	setRequestProperties(TypedProperty reqProperties) This method sets the request properties.
void	setRequisitionListId(java.lang.Long id) This method specifies the requisition list id to be submitted.
void	validateParameters() This method validates the input parameters.

Methods inherited from class com.ibm.commerce.requisitionlist.commands.RequisitionListBaseCmdImpl

deleteRequisitionListHelper, getStatus, getType, reset, setRequisitionListStatus, setRequisitionListType

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

checkPermission, fulfills, getForUserId, getGeneric, getOwner, getRequestProperties, getResolvedRequestProperties, getResourceOwners, getResponseProperties, getRetriable, getViewInputProperties, isGeneric, isRetriable, mergeProperties, setForUserId, setGeneric, setOwner, setResponseProperties, setRetriable, setViewInputProperties

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

accessControlCheck, checkIsAllowed, checkResourcePermission, createCommandExecutionEvent, execute, getAccCheck, getCommandContext, getCommandIfName, getCommandName, getCommandStoreId, getDefaultProperties, getExceptionInvokeParameters, getObjectSize, getPostInvokeParameters, getPreInvokeParameters, 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.ControllerCommand

checkPermission, execute, getGeneric, getRequestProperties, getResolvedRequestProperties, getResponseProperties, getRetriable, getViewInputProperties, isGeneric, isRetriable, mergeProperties, setGeneric, setRetriable, setViewInputProperties

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

accessControlCheck, getAccCheck, getForUserId, getResourceOwners, setAccCheck, setForUserId, setOwner

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

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

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

isReadyToCallExecute, reset

Methods inherited from interface com.ibm.commerce.security.Protectable

fulfills, getOwner

Field Detail

COPYRIGHT

public static final java.lang.String COPYRIGHT

The IBM copyright notice field.

See Also:

Constant Field Values

Constructor Detail

RequisitionListSubmitCmdImpl

public RequisitionListSubmitCmdImpl()

Method Detail

getMergeToCurrentPendingOrder

public java.lang.String getMergeToCurrentPendingOrder()

This method returns the indicator to represent whether the requisition list is to be merged into current pending order.

Returns:

the String value "Y" to merge the requisition list into current pending order; "N" not to merge.

setMergeToCurrentPendingOrder

public void setMergeToCurrentPendingOrder(java.lang.String flag)

This method sets the indicator to represent whether the requisition list is to be merged into current pending order.

Parameters:

flag - the String value "Y" to merge the requisition list into current pending order; "N" not to merge.

addOrderItemNVPs

public void addOrderItemNVPs(TypedProperty req,
                             OrderItemAccessBean orderItemAB,
                             int i)
                      throws java.sql.SQLException,
                             ECException

This method adds some name value pairs to the request properties based on the columns in the orderItamAB. If the catalogEntryId in orderItemAB is not null, it will add an nvp ("catEntryId_i", orderItemAB.getCatalogEntryId()) to request properties. The following columns are checked:

• catalogEntryId
• quantity
• addressId
• shippingModeId
• comment
• field1
• field2

Parameters:

req - request properties

orderItemAB - OrderItemAccessBean

i - int

Throws:

ECException

java.sql.SQLException

getOrderId

public java.lang.Long getOrderId()

This method returns the order id.

Returns:

order id.

getResources

public AccessVector getResources()
                          throws ECException

This method returns the store access bean and the order access bean.

Specified by:

getResources in interface ECCommand

Overrides:

getResources in class AbstractECTargetableCommand

Returns:

AccessVector.

Throws:

ECException

performExecute

public void performExecute()
                    throws ECException

This method is the main execution of the command. It calls the following methods:

• action()
• updateResponseView()

Specified by:

performExecute in interface ECCommand

Specified by:

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

Overrides:

performExecute in class AbstractECTargetableCommand

Throws:

ECException

setContractId

public void setContractId(java.lang.Long[] id)

This method specifies an array of contract ids for price calculation.

Specified by:

setContractId in interface RequisitionListSubmitCmd

Parameters:

id - an array of contract ids.

setOfferId

public void setOfferId(java.lang.Long[] id)

This method specifies an array of offer ids for price calculation.

Specified by:

setOfferId in interface RequisitionListSubmitCmd

Parameters:

id - an array of offer ids.

setRequestProperties

public void setRequestProperties(TypedProperty reqProperties)
                          throws ECException

This method sets the request properties.

Specified by:

setRequestProperties in interface ControllerCommand

Overrides:

setRequestProperties in class RequisitionListBaseCmdImpl

Parameters:

reqProperties - request properties.

Throws:

ECException

setRequisitionListId

public void setRequisitionListId(java.lang.Long id)

This method specifies the requisition list id to be submitted.

Specified by:

setRequisitionListId in interface RequisitionListSubmitCmd

Parameters:

id - requisition list id

validateParameters

public void validateParameters()
                        throws ECException

This method validates the input parameters.

It checks the following mandatory parameters:

• requisitionListId

It also checks the validation of the following parameter values:

• requisitionListId

Exception:

• It throws an ECApplicationException with the message key _ERR_BAD_MISSING_CMD_PARAMETER, if the input parameter requisitionListId is not found.
• It throws an ECApplicationException with the message key _ERR_INVALID_ORDER_REFNUM, if the input parameter requisitionListId is not a valid order id.

Specified by:

validateParameters in interface ECCommand

Overrides:

validateParameters in class AbstractECTargetableCommand

Throws:

ECException