RLPromotionComponentConfiguration

java.lang.Object
- com.ibm.commerce.tools.epromotion.RLPromotionComponentConfiguration

All Implemented Interfaces:: ComponentConfiguration

public class RLPromotionComponentConfiguration
extends java.lang.Object
implements ComponentConfiguration

This class represents the promotion component configuration

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String COPYRIGHT
IBM copyright notice field.

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

Constructor Summary

Constructors
Constructor and Description

RLPromotionComponentConfiguration()
The constructor for RLPromotionComponentConfiguration.

Constructors
Constructor and Description
`RLPromotionComponentConfiguration()` The constructor for RLPromotionComponentConfiguration.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`destroy()` This destroy method will be called when the request servlet is stopped or destroyed.
`void`	`enable(boolean newEnable)` This method is used to dynamically enable or disable a component.
`java.lang.String`	`getProjectName()` Deprecated. This implementation will no longer be supported. Blaze based promotion implementation is replaced by Commerce Marketing promotion implementation.
`java.lang.String`	`getProjectPath()` Deprecated. This implementation will no longer be supported. Blaze based promotion implementation is replaced by Commerce Marketing promotion implementation.
`java.lang.String`	`getPromotionEngineConfigFileLocation()` Get the location of the promotion engine configuration file.
`java.lang.String`	`getRepositoryName()` Deprecated. This implementation will no longer be supported. Blaze based promotion implementation is replaced by Commerce Marketing promotion implementation.
`java.lang.String`	`getRepositoryPath()` Deprecated. This implementation will no longer be supported. Blaze based promotion implementation is replaced by Commerce Marketing promotion implementation.
`RLPromotionFactory`	`getRLPromotionFactory()` Get the RLPromotionFactory.
`java.lang.String`	`getVersion()` Get the version of rule-based discounts component.
`void`	`init(org.w3c.dom.Element node)` The initialization method for the component.
`boolean`	`isComponentEngine()` Gets the boolean value whether or not the component promotion engine is used.
`void`	`registerPromotionType(org.w3c.dom.Node childNode)` This method is using to register promotion type.
`static RLPromotionComponentConfiguration`	`retrieveFromWcs()` This static method will retrieve RLPromotionComponentConfiguration object from the WebSphere Commerce Server instance.xml.
`void`	`setComponentEngine(boolean componentEngine)` Sets the boolean value whether or not the component promotion engine is used.
`void`	`setProjectName(java.lang.String proN)` Deprecated. This implementation will no longer be supported. Blaze based promotion implementation is replaced by Commerce Marketing promotion implementation.
`void`	`setProjectPath(java.lang.String proP)` Deprecated. This implementation will no longer be supported. Blaze based promotion implementation is replaced by Commerce Marketing promotion implementation.
`void`	`setPromotionEngineConfigFileLocation(java.lang.String string)` Set the location of the promotion engine configuration file.
`void`	`setRepositoryName(java.lang.String newRepositoryName)` Deprecated. This implementation will no longer be supported. Blaze based promotion implementation is replaced by Commerce Marketing promotion implementation.
`void`	`setRepositoryPath(java.lang.String newRepositoryPath)` Deprecated. This implementation will no longer be supported. Blaze based promotion implementation is replaced by Commerce Marketing promotion implementation.
`void`	`setRLPromotionFactory(RLPromotionFactory newFRLPromotionFactory)` sets the RLPromotionFactory.
`void`	`setVersion(java.lang.String newVersion)` Set the version of promotion component.

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
  - RLPromotionComponentConfiguration
```
public RLPromotionComponentConfiguration()
```
    The constructor for RLPromotionComponentConfiguration.
- Method Detail
  - destroy
```
public void destroy()
```
    This destroy method will be called when the request servlet is stopped or destroyed.
    
    Specified by:
    
    destroy in interface ComponentConfiguration
  - enable
```
public void enable(boolean newEnable)
            throws java.lang.Exception
```
    This method is used to dynamically enable or disable a component.
    
    Specified by:
    
    enable in interface ComponentConfiguration
    
    Parameters:
    
    val - boolean true - enable component, false - disable component
    
    Throws:
    
    java.lang.Exception
  - getProjectName
```
public java.lang.String getProjectName()
```
    Deprecated. This implementation will no longer be supported. Blaze based promotion implementation is replaced by Commerce Marketing promotion implementation.
    
    Get the project name.
    
    Returns:
    
    java.lang.String
  - getProjectPath
```
public java.lang.String getProjectPath()
```
    Deprecated. This implementation will no longer be supported. Blaze based promotion implementation is replaced by Commerce Marketing promotion implementation.
    
    Get the project path.
    
    Returns:
    
    java.lang.String
  - getRepositoryName
```
public java.lang.String getRepositoryName()
```
    Deprecated. This implementation will no longer be supported. Blaze based promotion implementation is replaced by Commerce Marketing promotion implementation.
    
    Get the repository name.
    
    Returns:
    
    java.lang.String
  - getRepositoryPath
```
public java.lang.String getRepositoryPath()
```
    Deprecated. This implementation will no longer be supported. Blaze based promotion implementation is replaced by Commerce Marketing promotion implementation.
    
    Get the repository path.
    
    Returns:
    
    java.lang.String
  - getVersion
```
public java.lang.String getVersion()
```
    Get the version of rule-based discounts component.
    
    Returns:
    
    java.lang.String
  - getRLPromotionFactory
```
public RLPromotionFactory getRLPromotionFactory()
```
    Get the RLPromotionFactory.
    
    Returns:
    
    com.ibm.commerce.tools.epromotion.RLPromotionFactory
  - init
```
public void init(org.w3c.dom.Element node)
          throws java.lang.Exception
```
    The initialization method for the component. This method will be called during initialization of the Request Servlet.
    
    Specified by:
    
    init in interface ComponentConfiguration
    
    Parameters:
    
    node - - a DOM element node with the parameters for the component, null if no property is presented.
    
    Throws:
    
    java.lang.Exception
  - registerPromotionType
```
public void registerPromotionType(org.w3c.dom.Node childNode)
```
    This method is using to register promotion type.
    
    Parameters:
    
    childNode - org.w3c.dom.Node
  - retrieveFromWcs
```
public static RLPromotionComponentConfiguration retrieveFromWcs()
```
    This static method will retrieve RLPromotionComponentConfiguration object from the WebSphere Commerce Server instance.xml.
    
    Returns:
    
    RLPromotionComponentConfiguration
  - setProjectName
```
public void setProjectName(java.lang.String proN)
```
    Deprecated. This implementation will no longer be supported. Blaze based promotion implementation is replaced by Commerce Marketing promotion implementation.
    
    Set the project name.
    
    Parameters:
    
    proN - java.lang.String
  - setProjectPath
```
public void setProjectPath(java.lang.String proP)
```
    Deprecated. This implementation will no longer be supported. Blaze based promotion implementation is replaced by Commerce Marketing promotion implementation.
    
    Set the project path.
    
    Parameters:
    
    proP - java.lang.String
  - setRepositoryName
```
public void setRepositoryName(java.lang.String newRepositoryName)
```
    Deprecated. This implementation will no longer be supported. Blaze based promotion implementation is replaced by Commerce Marketing promotion implementation.
    
    Set the repository name.
    
    Parameters:
    
    newRepositoryName - The repository name
  - setRLPromotionFactory
```
public void setRLPromotionFactory(RLPromotionFactory newFRLPromotionFactory)
```
    sets the RLPromotionFactory.
    
    Parameters:
    
    newFRLPromotionFactory - The RLPromotionFactory
  - setRepositoryPath
```
public void setRepositoryPath(java.lang.String newRepositoryPath)
```
    Deprecated. This implementation will no longer be supported. Blaze based promotion implementation is replaced by Commerce Marketing promotion implementation.
    
    Set the repository path.
    
    Parameters:
    
    newRepositoryPath - The repository path.
  - setVersion
```
public void setVersion(java.lang.String newVersion)
```
    Set the version of promotion component.
    
    Parameters:
    
    newVersion - The version of promotion component.
  - getPromotionEngineConfigFileLocation
```
public java.lang.String getPromotionEngineConfigFileLocation()
```
    Get the location of the promotion engine configuration file.
    
    Returns:
    
    String
  - setPromotionEngineConfigFileLocation
```
public void setPromotionEngineConfigFileLocation(java.lang.String string)
```
    Set the location of the promotion engine configuration file.
    
    Parameters:
    
    string -
  - isComponentEngine
```
public boolean isComponentEngine()
```
    Gets the boolean value whether or not the component promotion engine is used.
    
    Returns:
    
    Returns the bComponentEngine.
  - setComponentEngine
```
public void setComponentEngine(boolean componentEngine)
```
    Sets the boolean value whether or not the component promotion engine is used.
    
    Parameters:
    
    componentEngine - The ComponentEngine flag to set.

Methods inherited from class java.lang.Object

COPYRIGHT

RLPromotionComponentConfiguration

destroy

enable

getProjectName

getProjectPath

getRepositoryName

getRepositoryPath

getVersion

getRLPromotionFactory

init

registerPromotionType

retrieveFromWcs

setProjectName

setProjectPath

setRepositoryName

setRLPromotionFactory

setRepositoryPath

setVersion

getPromotionEngineConfigFileLocation

setPromotionEngineConfigFileLocation

isComponentEngine

setComponentEngine