public class SetOrderTemplateCmdImpl extends ControllerCommandImpl implements OrderConstants, SetOrderTemplateCmd
Name | Description |
---|---|
forUser | The logon ID of the user on whose behalf the command will be run. Only a person with the authority to process orders can specify this parameter. |
forUserId | Same as forUser, but identifying the user by the internal user ID as found in the USERS table. |
langId | Sets or resets the preferred language for the duration of the session; the supported languages for a store are found in the STORELANG table. |
URL | (Required) The URL to be called when the command completes successfully. |
storeId | Sets the store ID of the destination order. It is also used to resolve special abbreviations (".", "*", ".t", ".**.", and "*t") when they appear in fromOrderId_i, toOrderId, orderInfoFrom, and payInfoFrom. For example, the following command refers to all pending orders of member 1001 in store 1: fromOrderId_1=.&memberId_1=1001&storeId=1. |
orderId_i | Specifies zero or more orders, using order reference numbers or one of the Order abbreviations ".", "*", ".t", "*t" |
memberId_i | The reference number of a member, used to resolve special abbreviations (".", "*", ".t", ".**.", and "*t") when they appear in fromOrderId_i. For example, the following command refers to all pending orders of member 1001: fromOrderId_1=*&memberId_1=1001 The default value is the member ID of the current user. If the current customer attempts to access the orders of other customers but is not authorized to do so, an exception is thrown. |
usage_i | If orderId_i is specified, a value for usage_i must also be specified. Specify 1 to mark the specified orders as current template orders for the customer executing this command. Specify 0 to mark the orders as (non-current) template orders for the customer, and specify -1 to unmark the specified orders for the customer. |
storeId_i | The store reference number. It is used when evaluating the special abbreviations ".", "*", ".t", and "*t" for the value of the orderId_i parameter. If it is not specified, it defaults to the value provided by the storeId parameter. If neither storeId_i nor storeId are specified, then the special abbreviations are evaluated for all stores. |
outOrderName | Specifies the name-value pairs to be added to the redirection URL. The value of each name-value pair is the reference number of the destination order. The default value is "orderId". This parameter can be repeated. |
Modifier and Type | Field and Description |
---|---|
static java.lang.String | COPYRIGHT
The IBM copyright notice field.
|
Constructor and Description |
---|
SetOrderTemplateCmdImpl()
The default constructor.
|
Modifier and Type | Method and Description |
---|---|
void | checkIsAllowed(AccessVector resource, java.lang.String action)
This method is reserved for IBM internal use only.
|
void | checkOrderTemplate(OrderAccessBean aabOrder, java.lang.Integer anUsage)
This method is Reserved for IBM internal use only.
|
void | performExecute()
This method executes the business logic of this command implementation.
|
void | setGroups(SetOrderTemplateCmd.Group[] aGroups)
This method sets the enumerationGroups.
|
void | setOutOrderNames(java.lang.String[] astrOutOrderNames)
This method sets the names of the orderId NVPs to be appended to the redirection URL.
|
void | setRequestProperties(TypedProperty ahshRequestProperties)
This method sets the request properties.
|
void | validateParameters()
This method extracts and validates the input parameters of this command implementation.
|
public static final java.lang.String COPYRIGHT
public SetOrderTemplateCmdImpl()
public void checkIsAllowed(AccessVector resource, java.lang.String action) throws ECException
public void checkOrderTemplate(OrderAccessBean aabOrder, java.lang.Integer anUsage) throws javax.ejb.CreateException, ECException, javax.ejb.FinderException, javax.naming.NamingException, java.rmi.RemoteException
public void performExecute() throws ECException
public void setGroups(SetOrderTemplateCmd.Group[] aGroups)
public void setOutOrderNames(java.lang.String[] astrOutOrderNames)
public void setRequestProperties(TypedProperty ahshRequestProperties) throws ECApplicationException
public void validateParameters() throws ECException