org.broadleafcommerce.common.presentation

Annotation Type OptionFilterParam

@Retention(value=RUNTIME)
@Target(value=FIELD)
public @interface OptionFilterParam

Describes additional filter parameters used to refine the list of items returned from a query for a DataDrivenEnumeration

Author:

Jeff Fischer

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	param The field name in the target entity class that should be used to refine the query (i.e.
OptionFilterParamType	paramType This is the type for the value stored in this OptionFilterParam annotation.
String	value The field value that should match for any items returned from the query

Element Detail

param

public abstract String param

The field name in the target entity class that should be used to refine the query (i.e. sql where clause). The param can be "." delimited in standard bean property fashion. For example, the preferred way of referring to DataDrivenEnumerationValueImpl instances belonging to a particular instance of DataDrivenEnumerationImpl is by specifying the param value as follows:

param="type.key"

Returns:

the field name with which to refine the query

See Also:

DataDrivenEnumerationValueImpl

value

public abstract String value

The field value that should match for any items returned from the query

Returns:

the field match value

paramType

public abstract OptionFilterParamType paramType

This is the type for the value stored in this OptionFilterParam annotation. The system will use this type to properly convert the String value to the correct type when executing the query.

Returns:

the final type for the param value