org.broadleafcommerce.core.rule

Class RuleDTOConfig

java.lang.Object

org.broadleafcommerce.core.rule.RuleDTOConfig

public class RuleDTOConfig
extends Object

Provide confiration information about arbitrary field data used to drive rule builders in the admin. Can be employed to create dynamic RuleBuilderFieldService implementations with field data being derived from external sources.

Author:

Jeff Fischer

Field Summary

Fields

Modifier and Type	Field and Description
protected String	alternateName An alternate name for the field.
protected String	fieldName Name of the field as it appears in MVEL
protected String	label The name as it appears to the user in MVEL.
protected String	operators The type of operators for the rule
protected String	options The type of options to provide to the user for selection or entry
protected SupportedFieldType	type The type of the value being entered by the user

Constructor Summary

Constructors

Constructor and Description
RuleDTOConfig(String fieldName, String label)

Method Summary

Modifier and Type	Method and Description
String	getAlternateName()
String	getFieldName()
String	getLabel()
String	getOperators()
String	getOptions()
SupportedFieldType	getType()
void	setAlternateName(String alternateName)
void	setFieldName(String fieldName)
void	setLabel(String label)
void	setOperators(String operators)
void	setOptions(String options)
void	setType(SupportedFieldType type)

Methods inherited from class java.lang.Object

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

Field Detail

fieldName

protected String fieldName

Name of the field as it appears in MVEL

label

protected String label

The name as it appears to the user in MVEL. Specify a i18n key here instead and declare the key/value pair in a message property file for translatable labels.

operators

protected String operators

The type of operators for the rule

options

protected String options

The type of options to provide to the user for selection or entry

type

protected SupportedFieldType type

The type of the value being entered by the user

alternateName

protected String alternateName

An alternate name for the field. This is useful when the external source has a different name for the field than what you want to use in the rule builder.

Constructor Detail

RuleDTOConfig

public RuleDTOConfig(String fieldName,
                     String label)

Method Detail

getFieldName

public String getFieldName()

setFieldName

public void setFieldName(String fieldName)

getLabel

public String getLabel()

setLabel

public void setLabel(String label)

getOperators

public String getOperators()

setOperators

public void setOperators(String operators)

getOptions

public String getOptions()

setOptions

public void setOptions(String options)

getType

public SupportedFieldType getType()

setType

public void setType(SupportedFieldType type)

getAlternateName

public String getAlternateName()

setAlternateName

public void setAlternateName(String alternateName)