com.ibm.commerce.event

Class AbstractEventFactory

java.lang.Object

com.ibm.commerce.event.AbstractEventFactory

All Implemented Interfaces:

EventFactory

Direct Known Subclasses:

OrderCreationEventFactoryImpl, OrderGenericEventFactoryImpl, OrderItemCreationEventFactoryImpl, OrderItemUpdateEventFactoryImpl, OrderSubmissionEventFactoryImpl, OrderSubmitEventFactory, PaymentEventFactory

public abstract class AbstractEventFactory
extends java.lang.Object
implements EventFactory

This class defines an abstract implementation of the event factory. It will create the common base event object. This class is only responsible for creating the object and specifying the extension name of the event. Populating the event data into the common base event is the responsibility of the class that extends this implementation.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COPYRIGHT IBM copyright notice field.

Constructor Summary

Constructors

Constructor and Description
AbstractEventFactory() This is the default constructor for this class.

Method Summary

Modifier and Type	Method and Description
org.eclipse.hyades.logging.events.cbe.CommonBaseEvent	createEvent(java.lang.String eventIdentifier, java.lang.Object eventData) This method creates a common base event and specifies the extension name of the event as the event identifier specified.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

COPYRIGHT

public static final java.lang.String COPYRIGHT

IBM copyright notice field.

See Also:

Constant Field Values

Constructor Detail

AbstractEventFactory

public AbstractEventFactory()

This is the default constructor for this class. It calls the constructor from the superclass.

Method Detail

createEvent

public org.eclipse.hyades.logging.events.cbe.CommonBaseEvent createEvent(java.lang.String eventIdentifier,
                                                                         java.lang.Object eventData)

This method creates a common base event and specifies the extension name of the event as the event identifier specified. It calls populateEvent() to allow the class to add the event data to the common base event. The common base event that is created, whether the event data has been added or not, will be returned to the caller. This event will be given a low priority. It is up to the implementation of populateEvent to change the priority of the event if required.

Specified by:

createEvent in interface EventFactory

Parameters:

eventIdentifier - This is the event identifier.

eventData - This is the data to associate with the event.

Returns:

This method returns the common base event based on the event data.

See Also:

com.ibm.commerce.context.audit.event.EventFactory#createEvent(java.lang.String, java.lang.Object)