Package org.broadleafcommerce.openadmin.web.rulebuilder.enums

Class AbstractRuleBuilderEnumOptionsExtensionListener

java.lang.Object

org.broadleafcommerce.openadmin.web.rulebuilder.enums.AbstractRuleBuilderEnumOptionsExtensionListener

All Implemented Interfaces:

RuleBuilderEnumOptionsExtensionListener

public abstract class AbstractRuleBuilderEnumOptionsExtensionListener
extends Object
implements RuleBuilderEnumOptionsExtensionListener

Abstract extension listener for rule builder enum options that handles the boilerplate code required for setting up the response to the client. This class provides two abstract methods that must be implemented, #getVariableName() and #getEnumClass(). Generates a String with the following pattern:

 var variableName = [
     {"enumType": "enumFriendlyType"},
     {"enumType2": "enumFriendlyType2"},
     ...
     {"enumTypeN": "enumFriendlyTypeN"}
 ];
 

Author:

Andre Azzolini (apazzolini)

Constructor Summary

Constructors

Constructor	Description
AbstractRuleBuilderEnumOptionsExtensionListener()

Method Summary

Modifier and Type	Method	Description
String	getOptionValues()
protected Map<String,? extends BroadleafEnumerationType>	getTypes(Class<? extends BroadleafEnumerationType> clazz)
protected abstract Map<String,Class<? extends BroadleafEnumerationType>>	getValuesToGenerate()

Methods inherited from class java.lang.Object

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

Constructor Details

AbstractRuleBuilderEnumOptionsExtensionListener

public AbstractRuleBuilderEnumOptionsExtensionListener()

Method Details

getOptionValues

public String getOptionValues()

Specified by:

getOptionValues in interface RuleBuilderEnumOptionsExtensionListener

getTypes

protected Map<String,? extends BroadleafEnumerationType> getTypes(Class<? extends BroadleafEnumerationType> clazz)

getValuesToGenerate

protected abstract Map<String,Class<? extends BroadleafEnumerationType>> getValuesToGenerate()

Returns:

a map representing the various values that this extension listener should generate