ECEventEnableComponent

java.lang.Object
- com.ibm.commerce.event.impl.ECEventEnableComponent

All Implemented Interfaces:

ComponentConfiguration
```
public class ECEventEnableComponent
extends java.lang.Object
implements ComponentConfiguration
```
This class defines a WebSphere Commerce component used to enable and disable the events that are associated with the component.

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`COPYRIGHT` IBM copyright notice field.
`static java.lang.String`	`EVENT_NODE` This is the name of the event node.
`static java.lang.String`	`EVENT_NODE_NAME` This is the name of the attribute that contains the event name.
`static java.lang.String`	`EVENT_NODE_PRIORITY` This is the name of the attribute that contains the event name.

Constructor Summary

Constructors
Constructor and Description

ECEventEnableComponent()
This is the default constructor for this class.

Constructors
Constructor and Description
`ECEventEnableComponent()` This is the default constructor for this class.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`destroy()` This method calls the disable event for all the defined events for this component.
`void`	`enable(boolean val)` This method enables/disables component event names.
`void`	`init(org.w3c.dom.Element node)` This method loads the list of event names that is associated with this event component.

Methods inherited from class java.lang.Object
clone, equals, finalize, 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
  - EVENT_NODE
```
public static final java.lang.String EVENT_NODE
```
    This is the name of the event node.
    
    See Also:
    
    Constant Field Values
  - EVENT_NODE_NAME
```
public static final java.lang.String EVENT_NODE_NAME
```
    This is the name of the attribute that contains the event name.
    
    See Also:
    
    Constant Field Values
  - EVENT_NODE_PRIORITY
```
public static final java.lang.String EVENT_NODE_PRIORITY
```
    This is the name of the attribute that contains the event name.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - ECEventEnableComponent
```
public ECEventEnableComponent()
```
    This is the default constructor for this class. It calls the constructor from the superclass.
- Method Detail
  - destroy
```
public void destroy()
```
    This method calls the disable event for all the defined events for this component.
    
    Specified by:
    
    destroy in interface ComponentConfiguration
    
    See Also:
    
    ComponentConfiguration.destroy()
  - enable
```
public void enable(boolean val)
            throws java.lang.Exception
```
    This method enables/disables component event names. If the component is enabled, all the defined event names for this component will be enabled. If the component is disable then all the defined event names will be disabled.
    
    Specified by:
    
    enable in interface ComponentConfiguration
    
    Parameters:
    
    val - This is a boolean value that indicates whether the event is enabled or disabled.
    
    Throws:
    
    java.lang.Exception - This will not be thrown by this method.
    
    See Also:
    
    ComponentConfiguration.enable(boolean)
  - init
```
public void init(org.w3c.dom.Element node)
          throws java.lang.Exception
```
    This method loads the list of event names that is associated with this event component. The initialization will load all event nodes in the property configuration of the component.
    
    Specified by:
    
    init in interface ComponentConfiguration
    
    Parameters:
    
    node - This is an Element object that represents the event names configured for this component.
    
    Throws:
    
    java.lang.Exception - This is thrown when there is a problem traversing the element node.
    
    See Also:
    
    ComponentConfiguration.init(org.w3c.dom.Element)

Class ECEventEnableComponent

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

COPYRIGHT

EVENT_NODE

EVENT_NODE_NAME

EVENT_NODE_PRIORITY

Constructor Detail

ECEventEnableComponent

Method Detail

destroy

enable

init