com.ibm.commerce.bi.events

Interface EventProcessorCmd

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:

EventProcessorCmdImpl

public interface EventProcessorCmd
extends ControllerCommand

The interface used to process events generated by the Event Infrastructure for analytics. Events that have been generated and persisted in the BUSEVENT table will be processed and transformed into consumable events for external (non-WebSphere Commerce), analytics systems. All classes which will be processing the analytics events should implement this interface.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COPYRIGHT IBM Copyright
static java.lang.String	defaultCommandClassName The default implementation of this controller command, com.ibm.commerce.bi.events.EventProcessorCmdImpl
static java.lang.String	NAME The name of this interface, com.ibm.commerce.bi.events.EventProcessorCmd
static java.lang.String	PARAMETER_MAXEVENTS The parameter name to specify the maximum number of events to process.
static java.lang.String	PARAMETER_OUTPUT The parameter name to specify the output format.
static java.lang.String	PARAMETER_STOREID The parameter name to specify the store ID of which events will be processed.

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

serialVersionUID

Method Summary

Modifier and Type	Method and Description
void	setMaxEvents(int max) The maximum number of events to process.
void	setOutput(java.lang.String format) Sets the output format Possible values are �xml or �none�.
void	setStoreId(java.lang.Integer storeId) Sets the ID of the store of which events will be processed If provided, only the events for the particular store will be processed.

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

See Also:

Constant Field Values

NAME

static final java.lang.String NAME

The name of this interface, com.ibm.commerce.bi.events.EventProcessorCmd

See Also:

Constant Field Values

defaultCommandClassName

static final java.lang.String defaultCommandClassName

The default implementation of this controller command, com.ibm.commerce.bi.events.EventProcessorCmdImpl

See Also:

Constant Field Values

PARAMETER_MAXEVENTS

static final java.lang.String PARAMETER_MAXEVENTS

The parameter name to specify the maximum number of events to process.

See Also:

Constant Field Values

PARAMETER_OUTPUT

static final java.lang.String PARAMETER_OUTPUT

The parameter name to specify the output format. The value of this parameter should be one of OUTPUT_XML or OUTPUT_NONE.

See Also:

Constant Field Values

PARAMETER_STOREID

static final java.lang.String PARAMETER_STOREID

The parameter name to specify the store ID of which events will be processed.

See Also:

Constant Field Values

Method Detail

setMaxEvents

void setMaxEvents(int max)

The maximum number of events to process. If missing, all qualifying, unprocessed events in the system will be processed

Parameters:

max - the maximum number of events to process

setOutput

void setOutput(java.lang.String format)

Sets the output format Possible values are �xml or �none�. Default is �none�. In the common case, this command will be executed by the scheduler and so doesn�t require any output or view to be sent as a response. However, if set to �xml�, all of the transformed event XML�s will be returned as part the response view. This output mode is used for the File Generation Utility

Parameters:

format - One of OUTPUT_XML or OUTPUT_NONE.

setStoreId

void setStoreId(java.lang.Integer storeId)

Sets the ID of the store of which events will be processed If provided, only the events for the particular store will be processed. By default, all qualifying events for all stores will be worked on.

Parameters:

storeId - the ID of the store of which events will be processed