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 Detail

      • 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 doesnt require any output or view to be sent as a response. However, if set to xml, all of the transformed event XMLs 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