com.broadleafcommerce.customfield.domain

Class CustomFieldImpl

java.lang.Object

org.broadleafcommerce.core.search.domain.FieldImpl

com.broadleafcommerce.customfield.domain.CustomFieldImpl

All Implemented Interfaces:

CustomField, CustomFieldAdminPresentation, Serializable, org.broadleafcommerce.common.admin.domain.AdminMainEntity, org.broadleafcommerce.common.copy.MultiTenantCloneable<org.broadleafcommerce.core.search.domain.Field>, org.broadleafcommerce.core.search.domain.Field, org.broadleafcommerce.core.search.domain.FieldAdminPresentation

@Entity
public class CustomFieldImpl
extends org.broadleafcommerce.core.search.domain.FieldImpl
implements CustomField, CustomFieldAdminPresentation

Author:

Jeff Fischer

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface com.broadleafcommerce.customfield.domain.CustomFieldAdminPresentation

CustomFieldAdminPresentation.FieldOrder, CustomFieldAdminPresentation.GroupName, CustomFieldAdminPresentation.GroupOrder, CustomFieldAdminPresentation.TabName, CustomFieldAdminPresentation.TabOrder

Nested classes/interfaces inherited from interface org.broadleafcommerce.core.search.domain.FieldAdminPresentation

org.broadleafcommerce.core.search.domain.FieldAdminPresentation.FieldOrder, org.broadleafcommerce.core.search.domain.FieldAdminPresentation.GroupName, org.broadleafcommerce.core.search.domain.FieldAdminPresentation.GroupOrder, org.broadleafcommerce.core.search.domain.FieldAdminPresentation.TabName, org.broadleafcommerce.core.search.domain.FieldAdminPresentation.TabOrder

Field Summary

Fields

Modifier and Type	Field and Description
protected List<AllowedEnumValue>	allowedEnumValues
protected Boolean	allowMultiValueSelect
protected String	attributeName Deprecated. use FieldImpl.propertyName instead
protected Boolean	createNewGroup
protected String	customFieldTarget Deprecated. use FieldImpl#entitytype instead
protected String	customFieldType
protected Integer	fieldOrder
protected String	groupName
protected Boolean	showFieldInRuleBuilder
protected Boolean	showFieldOnForm
protected String	tabName

Fields inherited from class org.broadleafcommerce.core.search.domain.FieldImpl

abbreviation, entityType, friendlyName, id, overrideGeneratedPropertyName, propertyName, translatable

Fields inherited from interface org.broadleafcommerce.common.admin.domain.AdminMainEntity

MAIN_ENTITY_NAME_PROPERTY

Constructor Summary

Constructors

Constructor and Description
CustomFieldImpl()

Method Summary

Modifier and Type	Method and Description
List<AllowedEnumValue>	getAllowedEnumValues() Returns the list of allowed values for this custom field if it is an ENUMERATION type.
Boolean	getAllowMultiValueSelect() Get whether multiple values are allowed to be selected for this enum CustomField
String	getAttributeName() Deprecated.
Boolean	getCreateNewGroup() Whether or not a new FieldGroup should be created for the target EntityForm.
String	getCustomFieldTarget() Deprecated.
CustomFieldType	getCustomFieldType() The type for this field (e.g.
org.broadleafcommerce.core.search.domain.FieldEntity	getEntityType()
Integer	getFieldOrder() Optional - The order for this field in the form
String	getGroupName() Optional - The group in the target entity in which this field will reside.
String	getPropertyName()
String	getRawEntityType() Retrieve the raw, fully-qualified classname for the entity type targeted in this custom field
Boolean	getShowFieldInRuleBuilder() Whether or not this field is available to rule builders based on the target entity.
Boolean	getShowFieldOnForm() Whether or not this field is visible on the target entity form.
String	getTabName() Optional - The tab in the target entity in which this field will reside
void	setAllowedEnumValues(List<AllowedEnumValue> allowedEnumValues) Sets the list of allowed values for this custom field if it is an ENUMERATION type.
void	setAllowMultiValueSelect(Boolean allowMultiValueSelect) Set whether multiple values are allowed to be selected for this enum CustomField
void	setAttributeName(String attributeName) Deprecated.
void	setCreateNewGroup(Boolean createNewGroup) Whether or not a new FieldGroup should be created for the target EntityForm.
void	setCustomFieldTarget(String customFieldTarget) Deprecated.
void	setCustomFieldType(CustomFieldType customFieldType) The type for this field (e.g.
void	setEntityType(CustomFieldTargetType customFieldTargetType) Set the value that gets saved to BLC_FIELD.ENTITY_TYPE.
void	setFieldOrder(Integer groupOrder) Optional - the order for this field in the form
void	setGroupName(String groupName) Optional - The group in the target entity in which this field will reside.
void	setShowFieldInRuleBuilder(Boolean showFieldInRuleBuilder) Whether or not this field is available to rule builders based on the target entity.
void	setShowFieldOnForm(Boolean showFieldOnForm) Whether or not this field is visible on the target entity form.
void	setTabName(String tabName) Optional - The tab in the target entity in which this field will reside

Methods inherited from class org.broadleafcommerce.core.search.domain.FieldImpl

createOrRetrieveCopyInstance, equals, getAbbreviation, getFriendlyName, getId, getMainEntityName, getOverrideGeneratedPropertyName, getQualifiedFieldName, getSearchConfigs, getTranslatable, setAbbreviation, setEntityType, setFriendlyName, setId, setOverrideGeneratedPropertyName, setPropertyName, setSearchConfigs, setTranslatable

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.broadleafcommerce.core.search.domain.Field

getAbbreviation, getFriendlyName, getId, getOverrideGeneratedPropertyName, getQualifiedFieldName, getSearchConfigs, getTranslatable, setAbbreviation, setEntityType, setFriendlyName, setId, setOverrideGeneratedPropertyName, setPropertyName, setSearchConfigs, setTranslatable

Methods inherited from interface org.broadleafcommerce.common.copy.MultiTenantCloneable

createOrRetrieveCopyInstance

Field Detail

customFieldTarget

@Deprecated
protected String customFieldTarget

Deprecated. use FieldImpl#entitytype instead

attributeName

@Deprecated
protected String attributeName

Deprecated. use FieldImpl.propertyName instead

customFieldType

protected String customFieldType

showFieldOnForm

protected Boolean showFieldOnForm

showFieldInRuleBuilder

protected Boolean showFieldInRuleBuilder

createNewGroup

protected Boolean createNewGroup

groupName

protected String groupName

tabName

protected String tabName

fieldOrder

protected Integer fieldOrder

allowedEnumValues

protected List<AllowedEnumValue> allowedEnumValues

allowMultiValueSelect

protected Boolean allowMultiValueSelect

Constructor Detail

CustomFieldImpl

public CustomFieldImpl()

Method Detail

getCustomFieldTarget

@Deprecated
public String getCustomFieldTarget()

Deprecated.

Description copied from interface: CustomField

The fully qualified class name of the entity whose attribute map should contain this custom field.

Specified by:

getCustomFieldTarget in interface CustomField

Returns:

the fully qualified class name of the entity

setCustomFieldTarget

@Deprecated
public void setCustomFieldTarget(String customFieldTarget)

Deprecated.

Description copied from interface: CustomField

The fully qualified class name of the entity whose attribute map should contain this custom field.

Specified by:

setCustomFieldTarget in interface CustomField

Parameters:

customFieldTarget - the fully qualified class name of the entity

setEntityType

public void setEntityType(CustomFieldTargetType customFieldTargetType)

Description copied from interface: CustomField

Set the value that gets saved to BLC_FIELD.ENTITY_TYPE.

Specified by:

setEntityType in interface CustomField

getEntityType

public org.broadleafcommerce.core.search.domain.FieldEntity getEntityType()

Specified by:

getEntityType in interface org.broadleafcommerce.core.search.domain.Field

Overrides:

getEntityType in class org.broadleafcommerce.core.search.domain.FieldImpl

getRawEntityType

public String getRawEntityType()

Description copied from interface: CustomField

Retrieve the raw, fully-qualified classname for the entity type targeted in this custom field

Specified by:

getRawEntityType in interface CustomField

Returns:

getCustomFieldType

public CustomFieldType getCustomFieldType()

Description copied from interface: CustomField

The type for this field (e.g. Boolean, Date, ...). This drives the picker and validation in the admin.

Specified by:

getCustomFieldType in interface CustomField

Returns:

The type for this field

setCustomFieldType

public void setCustomFieldType(CustomFieldType customFieldType)

Description copied from interface: CustomField

The type for this field (e.g. Boolean, Date, ...). This drives the picker and validation in the admin.

Specified by:

setCustomFieldType in interface CustomField

Parameters:

customFieldType - The type for this field

getFieldOrder

public Integer getFieldOrder()

Description copied from interface: CustomField

Optional - The order for this field in the form

Specified by:

getFieldOrder in interface CustomField

Returns:

the order of the field in the form

setFieldOrder

public void setFieldOrder(Integer groupOrder)

Description copied from interface: CustomField

Optional - the order for this field in the form

Specified by:

setFieldOrder in interface CustomField

Parameters:

groupOrder - the order of the field in the form

getGroupName

public String getGroupName()

Description copied from interface: CustomField

Optional - The group in the target entity in which this field will reside. Grouping effects visual organization of fields in the admin tool form. May be null, in which case the field will be in the default, general group.

Specified by:

getGroupName in interface CustomField

Returns:

The group in the target entity in which this field will reside.

setGroupName

public void setGroupName(String groupName)

Description copied from interface: CustomField

Optional - The group in the target entity in which this field will reside. Grouping effects visual organization of fields in the admin tool form. May be null, in which case the field will be in the default, general group.

Specified by:

setGroupName in interface CustomField

Parameters:

groupName - The group in the target entity in which this field will reside.

getTabName

public String getTabName()

Description copied from interface: CustomField

Optional - The tab in the target entity in which this field will reside

Specified by:

getTabName in interface CustomField

Returns:

the name of the tab this field should reside in

setTabName

public void setTabName(String tabName)

Description copied from interface: CustomField

Optional - The tab in the target entity in which this field will reside

Specified by:

setTabName in interface CustomField

getAttributeName

@Deprecated
public String getAttributeName()

Deprecated.

Description copied from interface: CustomField

The field attribute name that will be for the target entity attribute map key.

Specified by:

getAttributeName in interface CustomField

Returns:

the attribute name for this field

setAttributeName

@Deprecated
public void setAttributeName(String attributeName)

Deprecated.

Description copied from interface: CustomField

The field attributeName that will be for the target entity attribute map key.

Specified by:

setAttributeName in interface CustomField

Parameters:

attributeName - the attributeName for this field

getPropertyName

public String getPropertyName()

Specified by:

getPropertyName in interface org.broadleafcommerce.core.search.domain.Field

Overrides:

getPropertyName in class org.broadleafcommerce.core.search.domain.FieldImpl

getShowFieldInRuleBuilder

public Boolean getShowFieldInRuleBuilder()

Description copied from interface: CustomField

Whether or not this field is available to rule builders based on the target entity.

Specified by:

getShowFieldInRuleBuilder in interface CustomField

Returns:

whether or not this field appears in the rule builder

setShowFieldInRuleBuilder

public void setShowFieldInRuleBuilder(Boolean showFieldInRuleBuilder)

Description copied from interface: CustomField

Whether or not this field is available to rule builders based on the target entity.

Specified by:

setShowFieldInRuleBuilder in interface CustomField

Parameters:

showFieldInRuleBuilder - whether or not this field appears in the rule builder

getShowFieldOnForm

public Boolean getShowFieldOnForm()

Description copied from interface: CustomField

Whether or not this field is visible on the target entity form.

Specified by:

getShowFieldOnForm in interface CustomField

Returns:

whether or not this field appears on the target entity form

setShowFieldOnForm

public void setShowFieldOnForm(Boolean showFieldOnForm)

Description copied from interface: CustomField

Whether or not this field is visible on the target entity form.

Specified by:

setShowFieldOnForm in interface CustomField

Parameters:

showFieldOnForm - whether or not this field appears on the target entity form

getCreateNewGroup

public Boolean getCreateNewGroup()

Description copied from interface: CustomField

Whether or not a new FieldGroup should be created for the target EntityForm.

Specified by:

getCreateNewGroup in interface CustomField

Returns:

setCreateNewGroup

public void setCreateNewGroup(Boolean createNewGroup)

Description copied from interface: CustomField

Whether or not a new FieldGroup should be created for the target EntityForm.

Specified by:

setCreateNewGroup in interface CustomField

getAllowedEnumValues

public List<AllowedEnumValue> getAllowedEnumValues()

Description copied from interface: CustomField

Returns the list of allowed values for this custom field if it is an ENUMERATION type.

Specified by:

getAllowedEnumValues in interface CustomField

Returns:

setAllowedEnumValues

public void setAllowedEnumValues(List<AllowedEnumValue> allowedEnumValues)

Description copied from interface: CustomField

Sets the list of allowed values for this custom field if it is an ENUMERATION type.

Specified by:

setAllowedEnumValues in interface CustomField

getAllowMultiValueSelect

public Boolean getAllowMultiValueSelect()

Description copied from interface: CustomField

Get whether multiple values are allowed to be selected for this enum CustomField

Specified by:

getAllowMultiValueSelect in interface CustomField

Returns:

setAllowMultiValueSelect

public void setAllowMultiValueSelect(Boolean allowMultiValueSelect)

Description copied from interface: CustomField

Set whether multiple values are allowed to be selected for this enum CustomField

Specified by:

setAllowMultiValueSelect in interface CustomField