org.broadleafcommerce.common.presentation

Annotation Type AdminPresentationToOneLookup

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

Author:

Jeff Fischer

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	lookupDisplayProperty Optional - only required if the display property is other than "name"
String	lookupParentDataSourceName Optional - only required if the parent datasource from the admin tool used to bind this lookup is other than the default top-level datasource.
String	targetDynamicFormDisplayId Optional - only required if the dynamic form used to display the lookup in the admin tool is other than the default top-level form.

Element Detail

lookupDisplayProperty

public abstract String lookupDisplayProperty

Optional - only required if the display property is other than "name"

Specify the property on a lookup class that should be used as the value to display to the user in a form in the admin tool UI

Returns:

the property on the lookup class containing the displayable value

Default:

"name"

lookupParentDataSourceName

public abstract String lookupParentDataSourceName

Optional - only required if the parent datasource from the admin tool used to bind this lookup is other than the default top-level datasource. Can only be used in conjunction with SupportedFieldType.ADDITIONAL_FOREIGN_KEY.

Specify an alternate datasource to bind the lookup to. This is an advanced setting.

Returns:

alternate datasource for lookup binding

Default:

""

targetDynamicFormDisplayId

public abstract String targetDynamicFormDisplayId

Optional - only required if the dynamic form used to display the lookup in the admin tool is other than the default top-level form. Can only be used in conjunction with SupportedFieldType.ADDITIONAL_FOREIGN_KEY.

Specify an alternate DynamicFormDisplay instance in which to show the lookup form item. This is an advanced setting.

Returns:

alternate DynamicFormDisplay for lookup display

Default:

""