org.broadleafcommerce.common.presentation

Annotation Type AdminPresentationDataDrivenEnumeration

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

Author:

Jeff Fischer

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
boolean	optionCanEditValues Optional - only required if you want to allow users to edit (or enter new values) in the dropdown.
String	optionDisplayFieldName Optional - only required if the optionListEntity is not DataDrivenEnumerationValueImpl.
OptionFilterParam[]	optionFilterParams Optional - only required if it is desirable to filter the list of items returned from the query for the optionListEntity.
boolean	optionHideIfEmpty Optional - only required if you want to hide this field when there are no enumerations provided
Class<?>	optionListEntity Optional - only required if the target entity is other than DataDrivenEnumerationValueImpl.
String	optionValueFieldName Optional - only required if the optionListEntity is not DataDrivenEnumerationValueImpl.

Element Detail

optionListEntity

public abstract Class<?> optionListEntity

Optional - only required if the target entity is other than DataDrivenEnumerationValueImpl. The annotated field must be of type String. DataDrivenEnumerationValueImpl is the standard entity for storing data driven enumerations, but a completely different entity (e.g. CountryImpl) could be substituted, if applicable.

Specify the target entity that should be queried for the list of options that will be presented to the user in a drop down list. The value selected from the dropdown will become the String value for this field.

Returns:

the entity class representing the data to populate a dropdown field in the admin tool

Default:

org.broadleafcommerce.common.enumeration.domain.DataDrivenEnumerationValueImpl.class

optionFilterParams

public abstract OptionFilterParam[] optionFilterParams

Optional - only required if it is desirable to filter the list of items returned from the query for the optionListEntity. This is useful if you only want to present part of a table as options in the data driven enumeration. Note, when configuring for optionListEntity equals DataDrivenEnumerationValueImpl, it is generally appropriate to denote:

@OptionFilterParam(param="type.key", value="[the key value of the DataDrivenEnumerationImpl instance]", paramType=[your param type])

Additional parameters with which to filter the list of options shown to the user in the admin tool

Returns:

list of parameters with which to filter the option list

Default:

{}

optionValueFieldName

public abstract String optionValueFieldName

Optional - only required if the optionListEntity is not DataDrivenEnumerationValueImpl.

Specify the field in the target entity that contains the value that will be persisted into this annotated field.

Returns:

the value field in the target entity

Default:

""

optionDisplayFieldName

public abstract String optionDisplayFieldName

Optional - only required if the optionListEntity is not DataDrivenEnumerationValueImpl.

Specify the field in the target entity that contains the display value that will be shown to the user in the dropdown field

Returns:

the display field in the target entity

Default:

""

optionCanEditValues

public abstract boolean optionCanEditValues

Optional - only required if you want to allow users to edit (or enter new values) in the dropdown. If true, users will be able to type their own value or select from one of the data-driven values. This is only required when the optionListEntity is not DataDrivenEnumerationValueImpl, since that class already defines this property (i.e. the modifiable property)

Whether or not the user can type in the data-driven field

Returns:

whether or not the user can type in the data-driven field

Default:

false

optionHideIfEmpty

public abstract boolean optionHideIfEmpty

Optional - only required if you want to hide this field when there are no enumerations provided

Whether or not to show the field if no Enumerations are provided.

Returns:

whether or not to show the field if empty

Default:

false