Package org.broadleafcommerce.cms.field.domain

Class FieldDefinitionImpl

java.lang.Object

org.broadleafcommerce.cms.field.domain.FieldDefinitionImpl

All Implemented Interfaces:

Serializable, FieldDefinition, MultiTenantCloneable<FieldDefinition>, ProfileEntity

@Entity
public class FieldDefinitionImpl
extends Object
implements FieldDefinition, ProfileEntity

Created by bpolster.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected Boolean	allowMultiples
protected String	columnWidth
protected DataDrivenEnumeration	dataDrivenEnumeration
protected FieldGroup	fieldGroup
protected Integer	fieldOrder
protected String	fieldType
protected String	friendlyName
protected String	helpText
protected Boolean	hiddenFlag
protected String	hint
protected Long	id
protected Integer	maxLength
protected String	name
protected Boolean	requiredFlag
protected String	securityLevel
protected Boolean	textAreaFlag
protected String	tooltip
protected String	validationErrorMesageKey
protected String	validationRegEx

Constructor Summary

Constructors

Constructor	Description
FieldDefinitionImpl()

Method Summary

Modifier and Type	Method	Description
<G extends FieldDefinition> CreateResponse<G>	createOrRetrieveCopyInstance(MultiTenantCopyContext context)	Clone this entity for the purpose of multiple tenancy.
String	getAdditionalForeignKeyClass()
Boolean	getAllowMultiples()
String	getColumnWidth()
DataDrivenEnumeration	getDataDrivenEnumeration()
FieldGroup	getFieldGroup()
int	getFieldOrder()
SupportedFieldType	getFieldType()
String	getFieldTypeVal()
String	getFriendlyName()
String	getHelpText()
Boolean	getHiddenFlag()
String	getHint()
Long	getId()
Integer	getMaxLength()
String	getName()
Boolean	getRequiredFlag()
String	getSecurityLevel()
Boolean	getTextAreaFlag()
String	getTooltip()
String	getValidationErrorMesageKey()
String	getValidationRegEx()
void	setAdditionalForeignKeyClass(String className)
void	setAllowMultiples(Boolean allowMultiples)
void	setColumnWidth(String columnWidth)
void	setDataDrivenEnumeration(DataDrivenEnumeration dataDrivenEnumeration)
void	setFieldGroup(FieldGroup fieldGroup)
void	setFieldOrder(int fieldOrder)
void	setFieldType(String fieldType)
void	setFieldType(SupportedFieldType fieldType)
void	setFriendlyName(String friendlyName)
void	setHelpText(String helpText)
void	setHiddenFlag(Boolean hiddenFlag)
void	setHint(String hint)
void	setId(Long id)
void	setMaxLength(Integer maxLength)
void	setName(String name)
void	setRequiredFlag(Boolean requiredFlag)
void	setSecurityLevel(String securityLevel)
void	setTextAreaFlag(Boolean textAreaFlag)
void	setTooltip(String tooltip)
void	setValidationErrorMesageKey(String validationErrorMesageKey)
void	setValidationRegEx(String validationRegEx)

Methods inherited from class java.lang.Object

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

Field Details

id

protected Long id

name

protected String name

friendlyName

protected String friendlyName

fieldType

protected String fieldType

securityLevel

protected String securityLevel

hiddenFlag

protected Boolean hiddenFlag

validationRegEx

protected String validationRegEx

validationErrorMesageKey

protected String validationErrorMesageKey

maxLength

protected Integer maxLength

columnWidth

protected String columnWidth

textAreaFlag

protected Boolean textAreaFlag

requiredFlag

protected Boolean requiredFlag

dataDrivenEnumeration

protected DataDrivenEnumeration dataDrivenEnumeration

allowMultiples

protected Boolean allowMultiples

fieldGroup

protected FieldGroup fieldGroup

fieldOrder

protected Integer fieldOrder

tooltip

protected String tooltip

helpText

protected String helpText

hint

protected String hint

Constructor Details

FieldDefinitionImpl

public FieldDefinitionImpl()

Method Details

getId

public Long getId()

Specified by:

getId in interface FieldDefinition

setId

public void setId(Long id)

Specified by:

setId in interface FieldDefinition

getName

public String getName()

Specified by:

getName in interface FieldDefinition

setName

public void setName(String name)

Specified by:

setName in interface FieldDefinition

getFieldType

public SupportedFieldType getFieldType()

Specified by:

getFieldType in interface FieldDefinition

setFieldType

public void setFieldType(SupportedFieldType fieldType)

Specified by:

setFieldType in interface FieldDefinition

setFieldType

public void setFieldType(String fieldType)

Specified by:

setFieldType in interface FieldDefinition

getFieldTypeVal

public String getFieldTypeVal()

Specified by:

getFieldTypeVal in interface FieldDefinition

getAdditionalForeignKeyClass

public String getAdditionalForeignKeyClass()

Specified by:

getAdditionalForeignKeyClass in interface FieldDefinition

setAdditionalForeignKeyClass

public void setAdditionalForeignKeyClass(String className)

Specified by:

setAdditionalForeignKeyClass in interface FieldDefinition

getSecurityLevel

public String getSecurityLevel()

Specified by:

getSecurityLevel in interface FieldDefinition

setSecurityLevel

public void setSecurityLevel(String securityLevel)

Specified by:

setSecurityLevel in interface FieldDefinition

getHiddenFlag

public Boolean getHiddenFlag()

Specified by:

getHiddenFlag in interface FieldDefinition

setHiddenFlag

public void setHiddenFlag(Boolean hiddenFlag)

Specified by:

setHiddenFlag in interface FieldDefinition

getValidationRegEx

public String getValidationRegEx()

Specified by:

getValidationRegEx in interface FieldDefinition

setValidationRegEx

public void setValidationRegEx(String validationRegEx)

Specified by:

setValidationRegEx in interface FieldDefinition

getMaxLength

public Integer getMaxLength()

Specified by:

getMaxLength in interface FieldDefinition

setMaxLength

public void setMaxLength(Integer maxLength)

Specified by:

setMaxLength in interface FieldDefinition

getColumnWidth

public String getColumnWidth()

Specified by:

getColumnWidth in interface FieldDefinition

setColumnWidth

public void setColumnWidth(String columnWidth)

Specified by:

setColumnWidth in interface FieldDefinition

getTextAreaFlag

public Boolean getTextAreaFlag()

Specified by:

getTextAreaFlag in interface FieldDefinition

setTextAreaFlag

public void setTextAreaFlag(Boolean textAreaFlag)

Specified by:

setTextAreaFlag in interface FieldDefinition

getRequiredFlag

public Boolean getRequiredFlag()

Specified by:

getRequiredFlag in interface FieldDefinition

setRequiredFlag

public void setRequiredFlag(Boolean requiredFlag)

Specified by:

setRequiredFlag in interface FieldDefinition

getAllowMultiples

public Boolean getAllowMultiples()

Specified by:

getAllowMultiples in interface FieldDefinition

setAllowMultiples

public void setAllowMultiples(Boolean allowMultiples)

Specified by:

setAllowMultiples in interface FieldDefinition

getFriendlyName

public String getFriendlyName()

Specified by:

getFriendlyName in interface FieldDefinition

setFriendlyName

public void setFriendlyName(String friendlyName)

Specified by:

setFriendlyName in interface FieldDefinition

getValidationErrorMesageKey

public String getValidationErrorMesageKey()

Specified by:

getValidationErrorMesageKey in interface FieldDefinition

setValidationErrorMesageKey

public void setValidationErrorMesageKey(String validationErrorMesageKey)

Specified by:

setValidationErrorMesageKey in interface FieldDefinition

getFieldGroup

public FieldGroup getFieldGroup()

Specified by:

getFieldGroup in interface FieldDefinition

setFieldGroup

public void setFieldGroup(FieldGroup fieldGroup)

Specified by:

setFieldGroup in interface FieldDefinition

getFieldOrder

public int getFieldOrder()

Specified by:

getFieldOrder in interface FieldDefinition

setFieldOrder

public void setFieldOrder(int fieldOrder)

Specified by:

setFieldOrder in interface FieldDefinition

getDataDrivenEnumeration

public DataDrivenEnumeration getDataDrivenEnumeration()

Specified by:

getDataDrivenEnumeration in interface FieldDefinition

setDataDrivenEnumeration

public void setDataDrivenEnumeration(DataDrivenEnumeration dataDrivenEnumeration)

Specified by:

setDataDrivenEnumeration in interface FieldDefinition

getTooltip

public String getTooltip()

Specified by:

getTooltip in interface FieldDefinition

setTooltip

public void setTooltip(String tooltip)

Specified by:

setTooltip in interface FieldDefinition

getHelpText

public String getHelpText()

Specified by:

getHelpText in interface FieldDefinition

setHelpText

public void setHelpText(String helpText)

Specified by:

setHelpText in interface FieldDefinition

getHint

public String getHint()

Specified by:

getHint in interface FieldDefinition

setHint

public void setHint(String hint)

Specified by:

setHint in interface FieldDefinition

createOrRetrieveCopyInstance

public <G extends FieldDefinition>
CreateResponse<G> createOrRetrieveCopyInstance(MultiTenantCopyContext context)
                                        throws CloneNotSupportedException

Description copied from interface: MultiTenantCloneable

Clone this entity for the purpose of multiple tenancy. Note, extending classes should follow this pattern:

public CreateResponse<MyClass> createOrRetrieveCopyInstance(MultiTenantCopyContext context) throws CloneNotSupportedException { CreateResponse<MyClass> createResponse = super.createOrRetrieveCopyInstance(context); if (createResponse.isAlreadyPopulated()) { return createResponse; } MyClass myClone = createResponse.getClone();

//copy extended field values on myClone here

return createResponse; }

Support should also be added for @Embeddable classes that contribute fields (collections or basic) to a cloneable entity:

public CreateResponse<G extends MyClass> createOrRetrieveCopyInstance(MultiTenantCopyContext context) throws CloneNotSupportedException { CreateResponse createResponse = context.createOrRetrieveCopyInstance(this); MyClass myClone = createResponse.getClone();

//copy extended field values on myClone here

return createResponse; }

Specified by:

createOrRetrieveCopyInstance in interface MultiTenantCloneable<FieldDefinition>

Parameters:

context - a context object providing persistence and library functionality for copying entities

Returns:

the resulting copy container, possibly already persisted

Throws:

CloneNotSupportedException - if there's a problem detected with the cloning configuration