com.ibm.commerce.event.impl.commands

Interface RaiseECEventCmd

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:

RaiseECEventCmdImpl

public interface RaiseECEventCmd
extends ControllerCommand

This class raises the common base events that have been locally saved. This command is intended to be executed by the scheduler to find all events that have not been raised and to raise them. Alternately a specific event can be specified and that will be raised regardless if it already has been processed. The parameter name to raise a specific event is "eventId". If this is not specified then all events that have not been processed will be raised.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COPYRIGHT IBM copyright notice field.
static java.lang.String	defaultCommandClassName This is the default implementation of this command.
static java.lang.String	EVENT_GLOBAL_ID_PARAM_NAME This is the parameter name to specify the event global identifier.
static java.lang.String	EVENT_ID_PARAM_NAME This is the parameter name to specify the event identifier.
static java.lang.String	NAME This is the name of this command.

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

serialVersionUID

Method Summary

Modifier and Type	Method and Description
java.lang.Long	getBusinessEventId() This method gets the business event identifier of the event to raise.
void	setBusinessEventId(java.lang.Long businessEventId) This method sets the business event identifier to raise.
void	setEventGlobalId(java.lang.String eventGlobalId) This method sets the name of the event to raise.
void	setSynchronous(boolean synchronous) This method indicates whether the command should process events in the current thread of execution or use another thread to process the events asynchronously.

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

IBM copyright notice field.

See Also:

Constant Field Values

NAME

static final java.lang.String NAME

This is the name of this command.

defaultCommandClassName

static final java.lang.String defaultCommandClassName

This is the default implementation of this command.

EVENT_ID_PARAM_NAME

static final java.lang.String EVENT_ID_PARAM_NAME

This is the parameter name to specify the event identifier.

See Also:

Constant Field Values

EVENT_GLOBAL_ID_PARAM_NAME

static final java.lang.String EVENT_GLOBAL_ID_PARAM_NAME

This is the parameter name to specify the event global identifier.

See Also:

Constant Field Values

Method Detail

getBusinessEventId

java.lang.Long getBusinessEventId()

This method gets the business event identifier of the event to raise. If null is returned then all possible events should be raised.

Returns:

This method returns the business event identifier that will be raised.

setBusinessEventId

void setBusinessEventId(java.lang.Long businessEventId)

This method sets the business event identifier to raise. If null is specified then all possible events will be raised.

Parameters:

businessEventId - This is the business event identifier to raise.

setEventGlobalId

void setEventGlobalId(java.lang.String eventGlobalId)

This method sets the name of the event to raise.

Parameters:

eventGlobalId - This is the event global identifier that identifies the event.

setSynchronous

void setSynchronous(boolean synchronous)

This method indicates whether the command should process events in the current thread of execution or use another thread to process the events asynchronously.

Parameters:

synchronous - This indicates whether the command should execute synchronously (true) or asynchronously (false).