BasicFieldMetadata (BroadleafCommerce Open Admin Platform 5.0.2-GA API)

java.lang.Object
- org.broadleafcommerce.openadmin.dto.FieldMetadata
- - org.broadleafcommerce.openadmin.dto.BasicFieldMetadata

All Implemented Interfaces:

Serializable
```
public class BasicFieldMetadata
extends FieldMetadata
```
Author:

Jeff Fischer

See Also:
Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected String`	`broadleafEnumeration`
`protected String`	`columnWidth`
`protected String[]`	`customCriteria`
`protected String`	`defaultValue`
`protected RuleBuilderDisplayType`	`displayType`
`protected Boolean`	`enableTypeaheadLookup`
`protected String`	`enumerationClass`
`protected String[][]`	`enumerationValues`
`protected SupportedFieldType`	`explicitFieldType`
`protected SupportedFieldType`	`fieldComponentRenderer`
`protected SupportedFieldType`	`fieldType`
`protected Boolean`	`forcePopulateChildProperties`
`protected String`	`foreignKeyClass`
`protected Boolean`	`foreignKeyCollection`
`protected String`	`foreignKeyDisplayValueProperty`
`protected String`	`foreignKeyProperty`
`protected Integer`	`gridOrder`
`protected Boolean`	`groupCollapsed` Deprecated.
`protected String`	`helpText`
`protected Boolean`	`hideEnumerationIfEmpty`
`protected String`	`hint`
`protected Boolean`	`isDerived`
`protected Boolean`	`isFilter`
`protected Boolean`	`largeEntry`
`protected Integer`	`length`
`protected String`	`lookupDisplayProperty`
`protected LookupType`	`lookupType`
`protected String`	`manyToField`
`protected String`	`mapFieldValueClass`
`protected String`	`mapKeyValueProperty`
`protected MergedPropertyType`	`mergedPropertyType`
`protected Boolean`	`mutable`
`protected String`	`name`
`protected Boolean`	`optionCanEditValues`
`protected String`	`optionDisplayFieldName`
`protected String[][]`	`optionFilterParams`
`protected Boolean`	`optionHideIfEmpty`
`protected String`	`optionListEntity`
`protected String`	`optionValueFieldName`
`protected Integer`	`precision`
`protected Boolean`	`prominent`
`protected Boolean`	`readOnly`
`protected Boolean`	`required`
`protected Boolean`	`requiredOverride`
`protected String`	`ruleIdentifier`
`protected Integer`	`scale`
`protected Boolean`	`searchable`
`protected SupportedFieldType`	`secondaryType`
`protected String`	`tooltip`
`protected Boolean`	`toOneLookupCreatedViaAnnotation`
`protected String`	`toOneParentProperty`
`protected String`	`toOneTargetProperty`
`protected Boolean`	`translatable`
`protected Boolean`	`unique`
`protected Boolean`	`useServerSideInspectionCache`
`protected Map<String,List<Map<String,String>>>`	`validationConfigurations`
`protected VisibilityEnum`	`visibility`

Constructor Summary

Constructors
Constructor and Description

BasicFieldMetadata()

Constructors
Constructor and Description
`BasicFieldMetadata()`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`accept(MetadataVisitor visitor)`
`FieldMetadata`	`cloneFieldMetadata()`
`boolean`	`equals(Object o)`
`String`	`getBroadleafEnumeration()`
`String`	`getColumnWidth()`
`String[]`	`getCustomCriteria()`
`String`	`getDefaultValue()`
`RuleBuilderDisplayType`	`getDisplayType()`
`Boolean`	`getEnableTypeaheadLookup()`
`String`	`getEnumerationClass()`
`String[][]`	`getEnumerationValues()`
`SupportedFieldType`	`getExplicitFieldType()`
`SupportedFieldType`	`getFieldComponentRenderer()`
`SupportedFieldType`	`getFieldType()`
`Boolean`	`getForcePopulateChildProperties()`
`String`	`getForeignKeyClass()`
`Boolean`	`getForeignKeyCollection()`
`String`	`getForeignKeyDisplayValueProperty()`
`String`	`getForeignKeyProperty()`
`Integer`	`getGridOrder()`
`Boolean`	`getGroupCollapsed()` Deprecated.
`String`	`getHelpText()`
`Boolean`	`getHideEnumerationIfEmpty()`
`String`	`getHint()`
`Boolean`	`getIsDerived()`
`Boolean`	`getIsFilter()`
`Integer`	`getLength()`
`String`	`getLookupDisplayProperty()`
`LookupType`	`getLookupType()`
`String`	`getManyToField()`
`String`	`getMapFieldValueClass()`
`String`	`getMapKeyValueProperty()`
`MergedPropertyType`	`getMergedPropertyType()`
`Boolean`	`getMutable()`
`String`	`getName()`
`Boolean`	`getOptionCanEditValues()`
`String`	`getOptionDisplayFieldName()`
`String[][]`	`getOptionFilterParams()`
`Boolean`	`getOptionHideIfEmpty()`
`String`	`getOptionListEntity()`
`String`	`getOptionValueFieldName()`
`Integer`	`getPrecision()`
`Boolean`	`getReadOnly()`
`Boolean`	`getRequired()`
`Boolean`	`getRequiredOverride()`
`String`	`getRuleIdentifier()`
`Integer`	`getScale()`
`Boolean`	`getSearchable()`
`SupportedFieldType`	`getSecondaryType()`
`String`	`getTooltip()`
`Boolean`	`getToOneLookupCreatedViaAnnotation()`
`String`	`getToOneParentProperty()`
`String`	`getToOneTargetProperty()`
`Boolean`	`getTranslatable()`
`Boolean`	`getUnique()`
`Boolean`	`getUseServerSideInspectionCache()`
`Map<String,List<Map<String,String>>>`	`getValidationConfigurations()`
`VisibilityEnum`	`getVisibility()`
`int`	`hashCode()`
`Boolean`	`isLargeEntry()`
`Boolean`	`isProminent()`
`void`	`setBroadleafEnumeration(String broadleafEnumeration)`
`void`	`setColumnWidth(String columnWidth)`
`void`	`setCustomCriteria(String[] customCriteria)`
`void`	`setDefaultValue(String defaultValue)`
`void`	`setDerived(Boolean isDerived)`
`void`	`setDisplayType(RuleBuilderDisplayType displayType)`
`void`	`setEnableTypeaheadLookup(Boolean enableTypeaheadLookup)`
`void`	`setEnumerationClass(String enumerationClass)`
`void`	`setEnumerationValues(String[][] enumerationValues)`
`void`	`setExplicitFieldType(SupportedFieldType fieldType)`
`void`	`setFieldComponentRenderer(SupportedFieldType fieldComponentRenderer)`
`void`	`setFieldType(SupportedFieldType fieldType)`
`void`	`setForcePopulateChildProperties(Boolean forcePopulateChildProperties)`
`void`	`setForeignKeyClass(String foreignKeyClass)`
`void`	`setForeignKeyCollection(Boolean foreignKeyCollection)`
`void`	`setForeignKeyDisplayValueProperty(String foreignKeyDisplayValueProperty)`
`void`	`setForeignKeyProperty(String foreignKeyProperty)`
`void`	`setGridOrder(Integer gridOrder)`
`void`	`setGroupCollapsed(Boolean groupCollapsed)` Deprecated.
`void`	`setHelpText(String helpText)`
`void`	`setHideEnumerationIfEmpty(Boolean hideEnumerationIfEmpty)`
`void`	`setHint(String hint)`
`void`	`setIsFilter(Boolean isFilter)`
`void`	`setLargeEntry(Boolean largeEntry)`
`void`	`setLength(Integer length)`
`void`	`setLookupDisplayProperty(String lookupDisplayProperty)`
`void`	`setLookupType(LookupType lookupType)`
`void`	`setManyToField(String manyToField)`
`void`	`setMapFieldValueClass(String mapFieldValueClass)`
`void`	`setMapKeyValueProperty(String mapKeyValueProperty)`
`void`	`setMergedPropertyType(MergedPropertyType mergedPropertyType)`
`void`	`setMutable(Boolean mutable)`
`void`	`setName(String name)`
`void`	`setOptionCanEditValues(Boolean optionCanEditValues)`
`void`	`setOptionDisplayFieldName(String optionDisplayFieldName)`
`void`	`setOptionFilterParams(String[][] optionFilterParams)`
`void`	`setOptionHideIfEmpty(Boolean optionHideIfEmpty)`
`void`	`setOptionListEntity(String optionListEntity)`
`void`	`setOptionValueFieldName(String optionValueFieldName)`
`void`	`setPrecision(Integer precision)`
`void`	`setProminent(Boolean prominent)`
`void`	`setReadOnly(Boolean readOnly)`
`void`	`setRequired(Boolean required)`
`void`	`setRequiredOverride(Boolean requiredOverride)`
`void`	`setRuleIdentifier(String ruleIdentifier)`
`void`	`setScale(Integer scale)`
`void`	`setSearchable(Boolean searchable)`
`void`	`setSecondaryType(SupportedFieldType secondaryType)`
`void`	`setTooltip(String tooltip)`
`void`	`setToOneLookupCreatedViaAnnotation(Boolean toOneLookupCreatedViaAnnotation)`
`void`	`setToOneParentProperty(String toOneParentProperty)`
`void`	`setToOneTargetProperty(String toOneTargetProperty)`
`void`	`setTranslatable(Boolean translatable)`
`void`	`setUnique(Boolean unique)`
`void`	`setUseServerSideInspectionCache(Boolean useServerSideInspectionCache)`
`void`	`setValidationConfigurations(Map<String,List<Map<String,String>>> validationConfigurations)`
`void`	`setVisibility(VisibilityEnum visibility)`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

fieldType
```
protected SupportedFieldType fieldType
```

secondaryType

protected SupportedFieldType secondaryType

length
```
protected Integer length
```

required
```
protected Boolean required
```

unique
```
protected Boolean unique
```

scale
```
protected Integer scale
```

precision
```
protected Integer precision
```

mutable
```
protected Boolean mutable
```

foreignKeyProperty
```
protected String foreignKeyProperty
```

foreignKeyClass
```
protected String foreignKeyClass
```

foreignKeyDisplayValueProperty

protected String foreignKeyDisplayValueProperty

foreignKeyCollection
```
protected Boolean foreignKeyCollection
```

mergedPropertyType

protected MergedPropertyType mergedPropertyType

enumerationValues
```
protected String[][] enumerationValues
```

enumerationClass
```
protected String enumerationClass
```

isDerived
```
protected Boolean isDerived
```

name
```
protected String name
```

visibility
```
protected VisibilityEnum visibility
```

groupCollapsed

@Deprecated
protected Boolean groupCollapsed

Deprecated.

explicitFieldType

protected SupportedFieldType explicitFieldType

displayType

protected RuleBuilderDisplayType displayType

largeEntry
```
protected Boolean largeEntry
```

prominent
```
protected Boolean prominent
```

gridOrder
```
protected Integer gridOrder
```

columnWidth
```
protected String columnWidth
```

broadleafEnumeration
```
protected String broadleafEnumeration
```

hideEnumerationIfEmpty

protected Boolean hideEnumerationIfEmpty

fieldComponentRenderer

protected SupportedFieldType fieldComponentRenderer

readOnly
```
protected Boolean readOnly
```

validationConfigurations

protected Map<String,List<Map<String,String>>> validationConfigurations

requiredOverride
```
protected Boolean requiredOverride
```

tooltip
```
protected String tooltip
```

helpText
```
protected String helpText
```

hint
```
protected String hint
```

lookupDisplayProperty
```
protected String lookupDisplayProperty
```

forcePopulateChildProperties

protected Boolean forcePopulateChildProperties

enableTypeaheadLookup

protected Boolean enableTypeaheadLookup

optionListEntity
```
protected String optionListEntity
```

optionValueFieldName
```
protected String optionValueFieldName
```

optionDisplayFieldName

protected String optionDisplayFieldName

optionCanEditValues
```
protected Boolean optionCanEditValues
```

optionHideIfEmpty
```
protected Boolean optionHideIfEmpty
```

optionFilterParams

protected String[][] optionFilterParams

customCriteria
```
protected String[] customCriteria
```

useServerSideInspectionCache

protected Boolean useServerSideInspectionCache

toOneLookupCreatedViaAnnotation

protected Boolean toOneLookupCreatedViaAnnotation

ruleIdentifier
```
protected String ruleIdentifier
```

lookupType
```
protected LookupType lookupType
```

translatable
```
protected Boolean translatable
```

defaultValue
```
protected String defaultValue
```

isFilter
```
protected Boolean isFilter
```

mapFieldValueClass
```
protected String mapFieldValueClass
```

searchable
```
protected Boolean searchable
```

manyToField
```
protected String manyToField
```

toOneTargetProperty
```
protected String toOneTargetProperty
```

toOneParentProperty
```
protected String toOneParentProperty
```

mapKeyValueProperty
```
protected String mapKeyValueProperty
```

Constructor Detail
- BasicFieldMetadata
```
public BasicFieldMetadata()
```

Method Detail

getFieldType

public SupportedFieldType getFieldType()

setFieldType

public void setFieldType(SupportedFieldType fieldType)

getSecondaryType

public SupportedFieldType getSecondaryType()

setSecondaryType

public void setSecondaryType(SupportedFieldType secondaryType)

getLength
```
public Integer getLength()
```

setLength

public void setLength(Integer length)

getRequired
```
public Boolean getRequired()
```

setRequired

public void setRequired(Boolean required)

getScale
```
public Integer getScale()
```

setScale
```
public void setScale(Integer scale)
```

getPrecision
```
public Integer getPrecision()
```

setPrecision

public void setPrecision(Integer precision)

getUnique
```
public Boolean getUnique()
```

setUnique

public void setUnique(Boolean unique)

getMutable
```
public Boolean getMutable()
```

setMutable

public void setMutable(Boolean mutable)

getForeignKeyProperty
```
public String getForeignKeyProperty()
```

setForeignKeyProperty

public void setForeignKeyProperty(String foreignKeyProperty)

getForeignKeyClass
```
public String getForeignKeyClass()
```

setForeignKeyClass

public void setForeignKeyClass(String foreignKeyClass)

getForeignKeyCollection

public Boolean getForeignKeyCollection()

setForeignKeyCollection

public void setForeignKeyCollection(Boolean foreignKeyCollection)

getMergedPropertyType

public MergedPropertyType getMergedPropertyType()

setMergedPropertyType

public void setMergedPropertyType(MergedPropertyType mergedPropertyType)

getEnumerationValues

public String[][] getEnumerationValues()

setEnumerationValues

public void setEnumerationValues(String[][] enumerationValues)

getForeignKeyDisplayValueProperty

public String getForeignKeyDisplayValueProperty()

setForeignKeyDisplayValueProperty

public void setForeignKeyDisplayValueProperty(String foreignKeyDisplayValueProperty)

getEnumerationClass
```
public String getEnumerationClass()
```

setEnumerationClass

public void setEnumerationClass(String enumerationClass)

getIsDerived
```
public Boolean getIsDerived()
```

setDerived

public void setDerived(Boolean isDerived)

getName
```
public String getName()
```

setName
```
public void setName(String name)
```

getExplicitFieldType

public SupportedFieldType getExplicitFieldType()

setExplicitFieldType

public void setExplicitFieldType(SupportedFieldType fieldType)

getDisplayType

public RuleBuilderDisplayType getDisplayType()

setDisplayType

public void setDisplayType(RuleBuilderDisplayType displayType)

isLargeEntry
```
public Boolean isLargeEntry()
```

setLargeEntry

public void setLargeEntry(Boolean largeEntry)

isProminent
```
public Boolean isProminent()
```

setProminent

public void setProminent(Boolean prominent)

getColumnWidth
```
public String getColumnWidth()
```

setColumnWidth

public void setColumnWidth(String columnWidth)

getBroadleafEnumeration

public String getBroadleafEnumeration()

setBroadleafEnumeration

public void setBroadleafEnumeration(String broadleafEnumeration)

getHideEnumerationIfEmpty

public Boolean getHideEnumerationIfEmpty()

setHideEnumerationIfEmpty

public void setHideEnumerationIfEmpty(Boolean hideEnumerationIfEmpty)

getFieldComponentRenderer

public SupportedFieldType getFieldComponentRenderer()

setFieldComponentRenderer

public void setFieldComponentRenderer(SupportedFieldType fieldComponentRenderer)

getReadOnly
```
public Boolean getReadOnly()
```

setReadOnly

public void setReadOnly(Boolean readOnly)

getGridOrder
```
public Integer getGridOrder()
```

setGridOrder

public void setGridOrder(Integer gridOrder)

getValidationConfigurations
```
public Map<String,List<Map<String,String>>> getValidationConfigurations()
```
Returns:
the validation configurations for this property keyed by the fully-qualified name of the PropertyValidator implementation

setValidationConfigurations

public void setValidationConfigurations(Map<String,List<Map<String,String>>> validationConfigurations)

getRequiredOverride
```
public Boolean getRequiredOverride()
```

setRequiredOverride

public void setRequiredOverride(Boolean requiredOverride)

getGroupCollapsed

@Deprecated
public Boolean getGroupCollapsed()

Deprecated.

setGroupCollapsed

@Deprecated
public void setGroupCollapsed(Boolean groupCollapsed)

Deprecated.

getTooltip
```
public String getTooltip()
```

setTooltip

public void setTooltip(String tooltip)

getHelpText
```
public String getHelpText()
```

setHelpText

public void setHelpText(String helpText)

getHint
```
public String getHint()
```

setHint
```
public void setHint(String hint)
```

getVisibility
```
public VisibilityEnum getVisibility()
```

setVisibility

public void setVisibility(VisibilityEnum visibility)

getLookupDisplayProperty

public String getLookupDisplayProperty()

setLookupDisplayProperty

public void setLookupDisplayProperty(String lookupDisplayProperty)

getForcePopulateChildProperties

public Boolean getForcePopulateChildProperties()

setForcePopulateChildProperties

public void setForcePopulateChildProperties(Boolean forcePopulateChildProperties)

getEnableTypeaheadLookup

public Boolean getEnableTypeaheadLookup()

setEnableTypeaheadLookup

public void setEnableTypeaheadLookup(Boolean enableTypeaheadLookup)

getOptionCanEditValues

public Boolean getOptionCanEditValues()

setOptionCanEditValues

public void setOptionCanEditValues(Boolean optionCanEditValues)

getOptionHideIfEmpty
```
public Boolean getOptionHideIfEmpty()
```

setOptionHideIfEmpty

public void setOptionHideIfEmpty(Boolean optionHideIfEmpty)

getOptionDisplayFieldName

public String getOptionDisplayFieldName()

setOptionDisplayFieldName

public void setOptionDisplayFieldName(String optionDisplayFieldName)

getOptionListEntity
```
public String getOptionListEntity()
```

setOptionListEntity

public void setOptionListEntity(String optionListEntity)

getOptionValueFieldName

public String getOptionValueFieldName()

setOptionValueFieldName

public void setOptionValueFieldName(String optionValueFieldName)

getOptionFilterParams

public String[][] getOptionFilterParams()

setOptionFilterParams

public void setOptionFilterParams(String[][] optionFilterParams)

getCustomCriteria
```
public String[] getCustomCriteria()
```

setCustomCriteria

public void setCustomCriteria(String[] customCriteria)

getUseServerSideInspectionCache

public Boolean getUseServerSideInspectionCache()

setUseServerSideInspectionCache

public void setUseServerSideInspectionCache(Boolean useServerSideInspectionCache)

getToOneLookupCreatedViaAnnotation

public Boolean getToOneLookupCreatedViaAnnotation()

setToOneLookupCreatedViaAnnotation

public void setToOneLookupCreatedViaAnnotation(Boolean toOneLookupCreatedViaAnnotation)

getRuleIdentifier
```
public String getRuleIdentifier()
```

setRuleIdentifier

public void setRuleIdentifier(String ruleIdentifier)

getMapFieldValueClass
```
public String getMapFieldValueClass()
```

setMapFieldValueClass

public void setMapFieldValueClass(String mapFieldValueClass)

getLookupType
```
public LookupType getLookupType()
```

getSearchable
```
public Boolean getSearchable()
```

setSearchable

public void setSearchable(Boolean searchable)

getManyToField
```
public String getManyToField()
```

setManyToField

public void setManyToField(String manyToField)

getToOneTargetProperty

public String getToOneTargetProperty()

setToOneTargetProperty

public void setToOneTargetProperty(String toOneTargetProperty)

getToOneParentProperty

public String getToOneParentProperty()

setToOneParentProperty

public void setToOneParentProperty(String toOneParentProperty)

getMapKeyValueProperty

public String getMapKeyValueProperty()

setMapKeyValueProperty

public void setMapKeyValueProperty(String mapKeyValueProperty)

setLookupType

public void setLookupType(LookupType lookupType)

getTranslatable
```
public Boolean getTranslatable()
```

setTranslatable

public void setTranslatable(Boolean translatable)

getDefaultValue
```
public String getDefaultValue()
```

setDefaultValue

public void setDefaultValue(String defaultValue)

getIsFilter
```
public Boolean getIsFilter()
```

setIsFilter

public void setIsFilter(Boolean isFilter)

cloneFieldMetadata
```
public FieldMetadata cloneFieldMetadata()
```
Specified by:

cloneFieldMetadata in class FieldMetadata

accept

public void accept(MetadataVisitor visitor)

Specified by:: accept in class FieldMetadata

equals
```
public boolean equals(Object o)
```
Overrides:

equals in class FieldMetadata

hashCode
```
public int hashCode()
```
Overrides:

hashCode in class FieldMetadata

Class BasicFieldMetadata

Field Summary

Constructor Summary

Method Summary

Methods inherited from class org.broadleafcommerce.openadmin.dto.FieldMetadata

Methods inherited from class java.lang.Object

Field Detail

fieldType

secondaryType

length

required

unique

scale

precision

mutable

foreignKeyProperty

foreignKeyClass

foreignKeyDisplayValueProperty

foreignKeyCollection

mergedPropertyType

enumerationValues

enumerationClass

isDerived

name

visibility

groupCollapsed

explicitFieldType

displayType

largeEntry

prominent

gridOrder

columnWidth

broadleafEnumeration

hideEnumerationIfEmpty

fieldComponentRenderer

readOnly

validationConfigurations

requiredOverride

tooltip

helpText

hint

lookupDisplayProperty

forcePopulateChildProperties

enableTypeaheadLookup

optionListEntity

optionValueFieldName

optionDisplayFieldName

optionCanEditValues

optionHideIfEmpty

optionFilterParams

customCriteria

useServerSideInspectionCache

toOneLookupCreatedViaAnnotation

ruleIdentifier

lookupType

translatable

defaultValue

isFilter

mapFieldValueClass

searchable

manyToField

toOneTargetProperty

toOneParentProperty

mapKeyValueProperty

Constructor Detail

BasicFieldMetadata

Method Detail

getFieldType

setFieldType

getSecondaryType

setSecondaryType

getLength

setLength

getRequired

setRequired

getScale

setScale

getPrecision

setPrecision

getUnique