com.ibm.commerce.order.commands

Interface RaiseOrderEventCmd

All Superinterfaces:

com.ibm.websphere.command.CacheableCommand, com.ibm.commerce.command.CacheableECCommand, com.ibm.websphere.command.Command, com.ibm.websphere.command.CommandCaller, ECCommand, java.io.Serializable, com.ibm.websphere.command.TargetableCommand, TaskCommand

All Known Implementing Classes:

RaiseOrderEventCmdImpl

public interface RaiseOrderEventCmd
extends TaskCommand

This Order task command is used to raise an order related event. Default implementation of this command is RaiseOrderEventCmdImpl.

Called by

• OrderCreateCmdImpl
• OrderItemBaseCmdImpl
• OrderProcessCmdImpl
• AdminOrderCancelCmdImpl
• ReleaseShipConfirmCmdImpl

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COPYRIGHT IBM copyright notice field.
static java.lang.String	defaultCommandClassName The default implementation class.
static java.lang.String	NAME The name of the Command Interface class.

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

serialVersionUID

Method Summary

Modifier and Type	Method and Description
java.util.HashMap	getEventData() This method gets the event data.
java.lang.Integer	getEventType() This method gets the event type.
TypedProperty	getRequestProperties() This method gets the request properties set by the setRequestProperties() method.
void	setEventData(java.util.HashMap ahsEventData) This method sets the event data.
void	setEventType(java.lang.Integer anEventType) This method sets the event type.
void	setRequestProperties(TypedProperty requestProperties) This method sets the request properties.

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

execute

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

isReadyToCallExecute, reset

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

unionDependencies

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

checkIsAllowed, checkResourcePermission, createCommandExecutionEvent, getAccCheck, getCommandContext, getCommandIfName, getCommandName, getCommandStoreId, getDefaultProperties, getExceptionInvokeParameters, getPostInvokeParameters, getPreInvokeParameters, getResources, getStoreId, getUser, getUserId, performExecute, setAccCheck, setCommandContext, setCommandIfName, setCommandStoreId, setDefaultProperties, validateParameters

Field Detail

COPYRIGHT

static final java.lang.String COPYRIGHT

IBM copyright notice field.

See Also:

Constant Field Values

NAME

static final java.lang.String NAME

The name of the Command Interface class.

See Also:

Constant Field Values

defaultCommandClassName

static final java.lang.String defaultCommandClassName

The default implementation class.

See Also:

Constant Field Values

Method Detail

getRequestProperties

TypedProperty getRequestProperties()

This method gets the request properties set by the setRequestProperties() method.

Returns:

This method returns the request properties.

getEventType

java.lang.Integer getEventType()

This method gets the event type.

Returns:

Returns the event type.

getEventData

java.util.HashMap getEventData()

This method gets the event data.

Returns:

Returns the event data.

setRequestProperties

void setRequestProperties(TypedProperty requestProperties)
                   throws ECException

This method sets the request properties.

Parameters:

requestProperties - This is an object that represents the request properties.

Throws:

ECException

setEventData

void setEventData(java.util.HashMap ahsEventData)

This method sets the event data.

Parameters:

ahsEventData - the event data to set.

setEventType

void setEventType(java.lang.Integer anEventType)

This method sets the event type.

Parameters:

anEventType - the event type.