Package org.cyclos.entities.system

Class CustomField<CF extends CustomField<CF,C,PV>,C extends CustomFieldPossibleValueCategory<CF,C,PV>,PV extends CustomFieldPossibleValue<CF,C,PV>>

java.lang.Object

org.cyclos.entities.SimpleEntity

org.cyclos.entities.NetworkedEntity

org.cyclos.entities.BaseEntity

org.cyclos.entities.NamedEntity

org.cyclos.entities.ConfigurationEntity

org.cyclos.entities.ConfigurationOrderableEntity

org.cyclos.entities.system.CustomField<CF,C,PV>

All Implemented Interfaces:

Cloneable, Comparable<NamedEntity>, HasNetwork, HasOrder, ProcessableForProxying, IEntity, IInternalNamedEntity, INamedEntity, IUnqualifiedInternalNamedEntity, HasValueMatch, ICustomField, UsesScript

Direct Known Subclasses:

AdCustomField, ContactCustomField, ContactInfoField, CustomOperationField, CustomWizardField, DocumentCustomField, RecordCustomField, TransactionCustomField, UserCustomField, VoucherCustomField

@MappedSuperclass
public abstract class CustomField<CF extends CustomField<CF,C,PV>,C extends CustomFieldPossibleValueCategory<CF,C,PV>,PV extends CustomFieldPossibleValue<CF,C,PV>>
extends ConfigurationOrderableEntity
implements ICustomField, HasValueMatch, IUnqualifiedInternalNamedEntity, UsesScript

Base class for custom fields

Nested Class Summary

Nested classes/interfaces inherited from class org.cyclos.entities.SimpleEntity

SimpleEntity.EntityLoadNotifier

Constructor Summary

Constructors

Constructor	Description
CustomField()

Method Summary

Modifier and Type	Method	Description
Set<FileMimeType>	getAllowedMimeTypes()
String	getAllSelectedLabel()
CustomFieldControl	getControl()
Integer	getDecimalDigits()
DecimalRange	getDecimalValueRange()
Boolean	getDefaultBooleanValue()
Date	getDefaultDateValue()
BigDecimal	getDefaultDecimalValue()
Integer	getDefaultIntegerValue()
String	getDefaultRichTextValue()
String	getDefaultStringValue()
String	getDefaultTextValue()
String	getInformationText()
IntegerRange	getIntegerValueRange()
IntegerRange	getLengthConstraint()
RecordType	getLinkedEntityRecordType()
LinkedEntityType	getLinkedEntityType()
CustomScript	getLoadValuesScript()
String	getLoadValuesScriptParameters()
Integer	getMaxFiles()
Integer	getMaxWordSize()
abstract CustomFieldNature	getNature()
String	getOtherMimeTypes()
String	getPattern()
abstract List<C>	getPossibleValueCategories()
abstract Class<C>	getPossibleValueCategoryClass()
abstract Class<PV>	getPossibleValueClass()
abstract List<PV>	getPossibleValues()
Boolean	getShowQrCodeScan()
CustomFieldSize	getSize()
String	getStorageDirectory()
CustomFieldType	getType()
CustomScript	getValidationScript()
String	getValidationScriptParameters()
ValueMatch	getValueMatch()	Returns the value match, or null if this field is not searchable
boolean	isAllowedAsSearchFilter()
boolean	isDefaultDateToday()
boolean	isExactMatch()
boolean	isExpandedCategories()
boolean	isIgnoreSanitizer()
boolean	isRequired()
boolean	isUnique()
void	setAllowedMimeTypes(Set<FileMimeType> mimeTypes)
void	setAllSelectedLabel(String allSelectedLabel)
void	setControl(CustomFieldControl control)
void	setDecimalDigits(Integer decimalDigits)
void	setDecimalValueRange(DecimalRange decimalValueRange)
void	setDefaultBooleanValue(Boolean defaultBooleanValue)
void	setDefaultDateToday(boolean defaultDateToday)
void	setDefaultDateValue(Date defaultDateValue)
void	setDefaultDecimalValue(BigDecimal defaultDecimalValue)
void	setDefaultIntegerValue(Integer defaultIntegerValue)
void	setDefaultRichTextValue(String defaultRichTextValue)
void	setDefaultStringValue(String defaultStringValue)
void	setDefaultTextValue(String defaultTextValue)
void	setExpandedCategories(boolean expandedCategories)
void	setIgnoreSanitizer(boolean ignoreSanitizer)
void	setInformationText(String informationText)
void	setIntegerValueRange(IntegerRange integerValueRange)
void	setLengthConstraint(IntegerRange lengthConstraint)
void	setLinkedEntityRecordType(RecordType linkedEntityRecordType)
void	setLinkedEntityType(LinkedEntityType linkedEntityType)
void	setLoadValuesScript(CustomScript loadValuesScript)
void	setLoadValuesScriptParameters(String loadValuesScriptParameters)
void	setMaxFiles(Integer maxFiles)
void	setMaxWordSize(Integer maxWordSize)
void	setOtherMimeTypes(String otherMimeTypes)
void	setPattern(String pattern)
void	setRequired(boolean required)
void	setShowQrCodeScan(Boolean showQrCodeScan)
void	setSize(CustomFieldSize size)
void	setStorageDirectory(String storageDirectory)
void	setType(CustomFieldType type)
void	setUnique(boolean unique)
void	setValidationScript(CustomScript validationScript)
void	setValidationScriptParameters(String validationScriptParameters)
void	setValueMatch(ValueMatch valueMatch)

Methods inherited from class org.cyclos.entities.ConfigurationOrderableEntity

compareTo, getOrder, setOrder, toString

Methods inherited from class org.cyclos.entities.ConfigurationEntity

getDescription, getInternalName, setDescription, setInternalName, toShortString

Methods inherited from class org.cyclos.entities.NamedEntity

getName, getNames, setName

Methods inherited from class org.cyclos.entities.BaseEntity

getDataTranslationType, getVersion

Methods inherited from class org.cyclos.entities.NetworkedEntity

isGlobal

Methods inherited from class org.cyclos.entities.SimpleEntity

equals, getId, hashCode, id, ids, isPersistent, isTransient, register, setId, uniqueIds, uniqueIds

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.cyclos.entities.HasNetwork

getNetwork

Methods inherited from interface org.cyclos.model.IEntity

getId, matches

Methods inherited from interface org.cyclos.model.IInternalNamedEntity

getInternalName, matches, setInternalName

Methods inherited from interface org.cyclos.model.INamedEntity

getName, setName

Methods inherited from interface org.cyclos.entities.ProcessableForProxying

getProxyClass

Methods inherited from interface org.cyclos.model.system.scripts.UsesScript

getScriptUsedInType, isEnabled

Constructor Detail

CustomField

public CustomField()

Method Detail

getAllowedMimeTypes

public Set<FileMimeType> getAllowedMimeTypes()

getAllSelectedLabel

public String getAllSelectedLabel()

getControl

public CustomFieldControl getControl()

getDecimalDigits

public Integer getDecimalDigits()

Specified by:

getDecimalDigits in interface ICustomField

getDecimalValueRange

public DecimalRange getDecimalValueRange()

getDefaultBooleanValue

public Boolean getDefaultBooleanValue()

getDefaultDateValue

public Date getDefaultDateValue()

getDefaultDecimalValue

public BigDecimal getDefaultDecimalValue()

getDefaultIntegerValue

public Integer getDefaultIntegerValue()

getDefaultRichTextValue

public String getDefaultRichTextValue()

getDefaultStringValue

public String getDefaultStringValue()

getDefaultTextValue

public String getDefaultTextValue()

getInformationText

public String getInformationText()

getIntegerValueRange

public IntegerRange getIntegerValueRange()

getLengthConstraint

public IntegerRange getLengthConstraint()

getLinkedEntityRecordType

public RecordType getLinkedEntityRecordType()

getLinkedEntityType

public LinkedEntityType getLinkedEntityType()

Specified by:

getLinkedEntityType in interface ICustomField

getLoadValuesScript

public CustomScript getLoadValuesScript()

getLoadValuesScriptParameters

public String getLoadValuesScriptParameters()

getMaxFiles

public Integer getMaxFiles()

getMaxWordSize

public Integer getMaxWordSize()

getNature

public abstract CustomFieldNature getNature()

getOtherMimeTypes

public String getOtherMimeTypes()

getPattern

public String getPattern()

getPossibleValueCategories

public abstract List<C> getPossibleValueCategories()

getPossibleValueCategoryClass

public abstract Class<C> getPossibleValueCategoryClass()

getPossibleValueClass

public abstract Class<PV> getPossibleValueClass()

getPossibleValues

public abstract List<PV> getPossibleValues()

getShowQrCodeScan

public Boolean getShowQrCodeScan()

getSize

public CustomFieldSize getSize()

getStorageDirectory

public String getStorageDirectory()

getType

public CustomFieldType getType()

Specified by:

getType in interface ICustomField

getValidationScript

public CustomScript getValidationScript()

getValidationScriptParameters

public String getValidationScriptParameters()

getValueMatch

public ValueMatch getValueMatch()

Description copied from interface: HasValueMatch

Returns the value match, or null if this field is not searchable

Specified by:

getValueMatch in interface HasValueMatch

isAllowedAsSearchFilter

public boolean isAllowedAsSearchFilter()

isDefaultDateToday

public boolean isDefaultDateToday()

isExactMatch

public boolean isExactMatch()

isExpandedCategories

public boolean isExpandedCategories()

isIgnoreSanitizer

public boolean isIgnoreSanitizer()

isRequired

public boolean isRequired()

isUnique

public boolean isUnique()

setAllowedMimeTypes

public void setAllowedMimeTypes(Set<FileMimeType> mimeTypes)

setAllSelectedLabel

public void setAllSelectedLabel(String allSelectedLabel)

setControl

public void setControl(CustomFieldControl control)

setDecimalDigits

public void setDecimalDigits(Integer decimalDigits)

setDecimalValueRange

public void setDecimalValueRange(DecimalRange decimalValueRange)

setDefaultBooleanValue

public void setDefaultBooleanValue(Boolean defaultBooleanValue)

setDefaultDateToday

public void setDefaultDateToday(boolean defaultDateToday)

setDefaultDateValue

public void setDefaultDateValue(Date defaultDateValue)

setDefaultDecimalValue

public void setDefaultDecimalValue(BigDecimal defaultDecimalValue)

setDefaultIntegerValue

public void setDefaultIntegerValue(Integer defaultIntegerValue)

setDefaultRichTextValue

public void setDefaultRichTextValue(String defaultRichTextValue)

setDefaultStringValue

public void setDefaultStringValue(String defaultStringValue)

setDefaultTextValue

public void setDefaultTextValue(String defaultTextValue)

setExpandedCategories

public void setExpandedCategories(boolean expandedCategories)

setIgnoreSanitizer

public void setIgnoreSanitizer(boolean ignoreSanitizer)

setInformationText

public void setInformationText(String informationText)

setIntegerValueRange

public void setIntegerValueRange(IntegerRange integerValueRange)

setLengthConstraint

public void setLengthConstraint(IntegerRange lengthConstraint)

setLinkedEntityRecordType

public void setLinkedEntityRecordType(RecordType linkedEntityRecordType)

setLinkedEntityType

public void setLinkedEntityType(LinkedEntityType linkedEntityType)

setLoadValuesScript

public void setLoadValuesScript(CustomScript loadValuesScript)

setLoadValuesScriptParameters

public void setLoadValuesScriptParameters(String loadValuesScriptParameters)

setMaxFiles

public void setMaxFiles(Integer maxFiles)

setMaxWordSize

public void setMaxWordSize(Integer maxWordSize)

setOtherMimeTypes

public void setOtherMimeTypes(String otherMimeTypes)

setPattern

public void setPattern(String pattern)

setRequired

public void setRequired(boolean required)

setShowQrCodeScan

public void setShowQrCodeScan(Boolean showQrCodeScan)

setSize

public void setSize(CustomFieldSize size)

setStorageDirectory

public void setStorageDirectory(String storageDirectory)

setType

public void setType(CustomFieldType type)

setUnique

public void setUnique(boolean unique)

setValidationScript

public void setValidationScript(CustomScript validationScript)

setValidationScriptParameters

public void setValidationScriptParameters(String validationScriptParameters)

setValueMatch

public void setValueMatch(ValueMatch valueMatch)