com.ibm.commerce.order.commands

Interface SetOrderTemplateCmd

All Superinterfaces:

AccCommand, com.ibm.websphere.command.CacheableCommand, com.ibm.websphere.command.Command, com.ibm.websphere.command.CommandCaller, ControllerCommand, ECCommand, Protectable, java.io.Serializable, com.ibm.websphere.command.TargetableCommand

All Known Implementing Classes:

SetOrderTemplateCmdImpl

public interface SetOrderTemplateCmd
extends ControllerCommand

This controller command is used to mark/unmark orders as orderTemplates. They can be accessed at a later time via orderAbbreviations '*t' (orderTemplates) and '.t' (currentOrderTemplates).
The default implementation of this command is SetOrderTemplateCmdImpl.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	SetOrderTemplateCmd.Group The SetOrderTemplate enumeration group.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COPYRIGHT The 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 of this command.
static java.lang.String	ERRCODE_ACCESS_DENIED The error code for access denied.
static java.lang.String	NAME The full name of this command.
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.

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

serialVersionUID

Method Summary

Modifier and Type	Method and Description
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.

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.websphere.command.CacheableCommand

executeFromCache, getCaller, getEntryInfo, getId, getSharingPolicy, postExecute, preExecute, setCaller, updateCache

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

getCommandTarget, getCommandTargetName, hasOutputProperties, performExecute, 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, getResources, getStoreId, getUser, getUserId, performExecute, setCommandContext, setCommandIfName, setCommandStoreId, setDefaultProperties, validateParameters

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

static final java.lang.String COPYRIGHT

The IBM copyright notice field.

See Also:

Constant Field Values

NAME

static final java.lang.String NAME

The full name of this command.

See Also:

Constant Field Values

defaultCommandClassName

static final java.lang.String defaultCommandClassName

The default implementation of this command.

See Also:

Constant Field Values

SET_ORDER_TEMPLATE_ERRVIEW

static final java.lang.String SET_ORDER_TEMPLATE_ERRVIEW

The error view.

See Also:

Constant Field Values

ERRCODE_ACCESS_DENIED

static final java.lang.String ERRCODE_ACCESS_DENIED

The error code for access denied.

See Also:

Constant Field Values

ORDER_TEMPLATE

static final java.lang.Integer ORDER_TEMPLATE

The constant for order template.

CURRENT_ORDER_TEMPATE

static final java.lang.Integer CURRENT_ORDER_TEMPATE

The constant for current order template.

UNMARK

static final java.lang.Integer UNMARK

The constant for unmark.

Method Detail

setGroups

void setGroups(SetOrderTemplateCmd.Group[] aGroups)

This method sets 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.
public String[] istrOrderAbbreviations - orderAbbreviations (for example '*').

Parameters:

aGroups - A Group[] that represents the enumerationGroups.

setOutOrderNames

void setOutOrderNames(java.lang.String[] astrOutOrderNames)

This method sets the names of the orderId NVPs to be appended to the redirection URL.

Parameters:

astrOutOrderNames - A String[] that represents the names of the orderId NVPs.