org.broadleafcommerce.common.web.expression

Class DataDrivenEnumVariableExpression

java.lang.Object

org.broadleafcommerce.common.web.expression.DataDrivenEnumVariableExpression

All Implemented Interfaces:

BroadleafVariableExpression

@Component(value="blDataDrivenEnumVariableExpression")
@ConditionalOnTemplating
public class DataDrivenEnumVariableExpression
extends Object
implements BroadleafVariableExpression

Variable expression that looks up a list of DataDrivenEnumerationValues based on its enum key

Author:

Phillip Verheyden (phillipuniverse)

Field Summary

Fields

Modifier and Type	Field and Description
protected DataDrivenEnumerationService	enumService

Constructor Summary

Constructors

Constructor and Description
DataDrivenEnumVariableExpression()

Method Summary

Methods

Modifier and Type	Method and Description
List<DataDrivenEnumerationValue>	getEnumValues(String key) Looks up a list of DataDrivenEnumerationValue by the DataDrivenEnumeration.getKey() specified by key
List<DataDrivenEnumerationValue>	getEnumValues(String key, String sort) Looks up a list of DataDrivenEnumerationValue by the DataDrivenEnumeration.getKey() specified by key
String	getName()

Methods inherited from class java.lang.Object

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

Field Detail

enumService

protected DataDrivenEnumerationService enumService

Constructor Detail

DataDrivenEnumVariableExpression

public DataDrivenEnumVariableExpression()

Method Detail

getName

public String getName()

Specified by:

getName in interface BroadleafVariableExpression

getEnumValues

public List<DataDrivenEnumerationValue> getEnumValues(String key)

Looks up a list of DataDrivenEnumerationValue by the DataDrivenEnumeration.getKey() specified by key

Parameters:

key - lookup for the DataDrivenEnumeration

Returns:

the list of DataDrivenEnumerationValue for the given key

getEnumValues

public List<DataDrivenEnumerationValue> getEnumValues(String key,
                                             String sort)

Looks up a list of DataDrivenEnumerationValue by the DataDrivenEnumeration.getKey() specified by key

Parameters:

key - lookup for the DataDrivenEnumeration

sort - optional, either 'ASCENDING' or 'DESCENDING' depending on how you want the result list sorted

Returns:

the list of DataDrivenEnumerationValue for the given key