com.ibm.commerce.order.commands

Interface OrderDisplayCmd

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:

OrderDisplayCmdImpl

public interface OrderDisplayCmd
extends ControllerCommand

This controller command is used to set the "viewTaskName" response property to display the contents of specified Orders for a user. According to the status input parameter. The default implementation of this command is OrderDisplayCmdImpl.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COPYRIGHT The IBM Copyright notice field.
static java.lang.String	defaultCommandClassName The default implementation of this command.
static java.lang.String	NAME The full name of this command.

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

serialVersionUID

Method Summary

Modifier and Type	Method and Description
void	setOrderId(java.util.Vector avOrderId) This method sets identifiers of the Orders to be displayed.
void	setOutOrderIds(java.lang.String[] aarrstrOutOrderIds) This method sets the names of the response properties to be created by the command.
void	setStatus(java.lang.String astrStatus) This method sets the status of the Orders to be displayed.

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

Method Detail

setOrderId

void setOrderId(java.util.Vector avOrderId)

This method sets identifiers of the Orders to be displayed. If this parameter is not specified, it defaults to all Orders with the status specified by the status parameter.

Parameters:

avOrderId - A Vector represents the Order identifiers (Vector of Long).

setOutOrderIds

void setOutOrderIds(java.lang.String[] aarrstrOutOrderIds)

This method sets the names of the response properties to be created by the command. The values of each response property are the identifiers of the Orders to be displayed.

Parameters:

aarrstrOutOrderIds - A String[] that specifies the names of the response properties to be created.

setStatus

void setStatus(java.lang.String astrStatus)

This method sets the status of the Orders to be displayed. If this parameter is not specified, it defaults to "P".

Parameters:

astrStatus - A String that indicates the Order status.