com.ibm.commerce.order.commands
Interface SetOrderTemplateCmd

All Superinterfaces:
AccCommand, ControllerCommand, ECCommand
All Known Implementing Classes:
SetOrderTemplateCmdImpl

public interface SetOrderTemplateCmd
extends ControllerCommand

Use this controller command to mark/unmark orders as orderTemplates. They can be accessed at a later time via orderAbbreviations '*t' (orderTemplates) and '.t' (currentOrderTemplates).


Nested Class Summary
static class SetOrderTemplateCmd.Group
          The SetOrderTemplate enumeration group.
 
Field Summary
static java.lang.String COPYRIGHT
          IBM copyright notice field.
static java.lang.Integer CURRENT_ORDER_TEMPATE
          The constant for current order template.
static java.lang.String defaultCommandClassName
          The default implementation class.
static java.lang.String ERRCODE_ACCESS_DENIED
          The error code for access denied.
static java.lang.String NAME
          The name of the Command Interface class.
static java.lang.Integer ORDER_TEMPLATE
          The constant for order template.
static java.lang.String SET_ORDER_TEMPLATE_ERRVIEW
          The error view.
static java.lang.Integer UNMARK
          The constant for unmark.
 
Method Summary
 void setGroups( SetOrderTemplateCmd.Group[] aGroups)           Set the enumerationGroups. An enumerationGroup consists of: public Long inMemberId - memberId to resolve orderAbbreviations in the enumerationGroup. public Integer inStoreId - storeId to resolve orderAbbreviations in the enumerationGroup. public Integer inUsage - 0 to mark, 1 to mark as current, -1 to unmark.br> public String[] istrOrderAbbreviations - orderAbbreviations (e.g.
 void setOutOrderNames(java.lang.String[] astrOutOrderNames)
          Set the names of the orderId NVPs to be appended to the redirection URL.
 
Methods inherited from interface com.ibm.commerce.command. ControllerCommand
checkPermission, execute, getGeneric, getRequestProperties, getResolvedRequestProperties, getResponseProperties, getRetriable, getViewInputProperties, isGeneric, isRetriable, mergeProperties, setGeneric, setRequestProperties, setRetriable, setViewInputProperties
 
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, getResources, getStoreId, getUser, getUserId, performExecute, setCommandContext, setCommandIfName, setCommandStoreId, setDefaultProperties, validateParameters
 

Field Detail
public static final java.lang.String COPYRIGHT
IBM copyright notice field.
See Also:
Constant Field Values

NAME

public static final java.lang.String NAME
The name of the Command Interface class.
See Also:
Constant Field Values

defaultCommandClassName

public static final java.lang.String defaultCommandClassName
The default implementation class.
See Also:
Constant Field Values

SET_ORDER_TEMPLATE_ERRVIEW

public static final java.lang.String SET_ORDER_TEMPLATE_ERRVIEW
The error view.
See Also:
Constant Field Values

ERRCODE_ACCESS_DENIED

public static final java.lang.String ERRCODE_ACCESS_DENIED
The error code for access denied.
See Also:
Constant Field Values

ORDER_TEMPLATE

public static final java.lang.Integer ORDER_TEMPLATE
The constant for order template.

CURRENT_ORDER_TEMPATE

public static final java.lang.Integer CURRENT_ORDER_TEMPATE
The constant for current order template.

UNMARK

public static final java.lang.Integer UNMARK
The constant for unmark.
Method Detail

setGroups

public void setGroups(SetOrderTemplateCmd.Group[] aGroups)
Set the enumerationGroups. An enumerationGroup consists of: public Long inMemberId - memberId to resolve orderAbbreviations in the enumerationGroup. public Integer inStoreId - storeId to resolve orderAbbreviations in the enumerationGroup. public Integer inUsage - 0 to mark, 1 to mark as current, -1 to unmark.br> public String[] istrOrderAbbreviations - orderAbbreviations (e.g. '*').
Parameters:
aGroups - the enumerationGroups.

setOutOrderNames

public void setOutOrderNames(java.lang.String[] astrOutOrderNames)
Set the names of the orderId NVPs to be appended to the redirection URL.
Parameters:
astrOutOrderNames - the names of the orderId NVPs.