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:

java.lang.Cloneable, java.lang.Comparable<NamedEntity>, HasOrder, ProcessableForDataTranslation, IEntity, IInternalNamedEntity, INamedEntity, IUnqualifiedInternalNamedEntity, HasValueMatch, ICustomField

Direct Known Subclasses:

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

@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

Base class for custom fields

Author:

luis, jefferson

Constructor Summary

Constructors

Constructor and Description
CustomField()

Method Summary

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

getNetwork, isGlobal

Methods inherited from class org.cyclos.entities.SimpleEntity

clone, equals, getId, getId, getIds, getUniqueIds, getUniqueIds, hashCode, isPersistent, isTransient

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.cyclos.model.INamedEntity

getName, setName

Methods inherited from interface org.cyclos.model.IInternalNamedEntity

getInternalName, matches, setInternalName

Methods inherited from interface org.cyclos.model.IEntity

getId, matches

Constructor Detail

CustomField

public CustomField()

Method Detail

getAllowedMimeTypes

public java.util.Set<FileMimeType> getAllowedMimeTypes()

getAllSelectedLabel

public java.lang.String getAllSelectedLabel()

getControl

public CustomFieldControl getControl()

getDecimalDigits

public java.lang.Integer getDecimalDigits()

Specified by:

getDecimalDigits in interface ICustomField

getDecimalValueRange

public DecimalRange getDecimalValueRange()

getDefaultBooleanValue

public java.lang.Boolean getDefaultBooleanValue()

getDefaultDateValue

public java.util.Date getDefaultDateValue()

getDefaultDecimalValue

public java.math.BigDecimal getDefaultDecimalValue()

getDefaultIntegerValue

public java.lang.Integer getDefaultIntegerValue()

getDefaultRichTextValue

public java.lang.String getDefaultRichTextValue()

getDefaultStringValue

public java.lang.String getDefaultStringValue()

getDefaultTextValue

public java.lang.String getDefaultTextValue()

getInformationText

public java.lang.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 java.lang.String getLoadValuesScriptParameters()

getMaxFiles

public java.lang.Integer getMaxFiles()

getMaxWordSize

public java.lang.Integer getMaxWordSize()

getNature

public abstract CustomFieldNature getNature()

getOtherMimeTypes

public java.lang.String getOtherMimeTypes()

getPattern

public java.lang.String getPattern()

getPossibleValueCategories

public abstract java.util.List<C> getPossibleValueCategories()

getPossibleValueCategoryClass

public abstract java.lang.Class<C> getPossibleValueCategoryClass()

getPossibleValueClass

public abstract java.lang.Class<PV> getPossibleValueClass()

getPossibleValues

public abstract java.util.List<PV> getPossibleValues()

getSize

public CustomFieldSize getSize()

getStorageDirectory

public java.lang.String getStorageDirectory()

getType

public CustomFieldType getType()

Specified by:

getType in interface ICustomField

getValidationScript

public CustomScript getValidationScript()

getValidationScriptParameters

public java.lang.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

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(java.util.Set<FileMimeType> mimeTypes)

setAllSelectedLabel

public void setAllSelectedLabel(java.lang.String allSelectedLabel)

setControl

public void setControl(CustomFieldControl control)

setDecimalDigits

public void setDecimalDigits(java.lang.Integer decimalDigits)

setDecimalValueRange

public void setDecimalValueRange(DecimalRange decimalValueRange)

setDefaultBooleanValue

public void setDefaultBooleanValue(java.lang.Boolean defaultBooleanValue)

setDefaultDateToday

public void setDefaultDateToday(boolean defaultDateToday)

setDefaultDateValue

public void setDefaultDateValue(java.util.Date defaultDateValue)

setDefaultDecimalValue

public void setDefaultDecimalValue(java.math.BigDecimal defaultDecimalValue)

setDefaultIntegerValue

public void setDefaultIntegerValue(java.lang.Integer defaultIntegerValue)

setDefaultRichTextValue

public void setDefaultRichTextValue(java.lang.String defaultRichTextValue)

setDefaultStringValue

public void setDefaultStringValue(java.lang.String defaultStringValue)

setDefaultTextValue

public void setDefaultTextValue(java.lang.String defaultTextValue)

setExpandedCategories

public void setExpandedCategories(boolean expandedCategories)

setIgnoreSanitizer

public void setIgnoreSanitizer(boolean ignoreSanitizer)

setInformationText

public void setInformationText(java.lang.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(java.lang.String loadValuesScriptParameters)

setMaxFiles

public void setMaxFiles(java.lang.Integer maxFiles)

setMaxWordSize

public void setMaxWordSize(java.lang.Integer maxWordSize)

setOtherMimeTypes

public void setOtherMimeTypes(java.lang.String otherMimeTypes)

setPattern

public void setPattern(java.lang.String pattern)

setRequired

public void setRequired(boolean required)

setSize

public void setSize(CustomFieldSize size)

setStorageDirectory

public void setStorageDirectory(java.lang.String storageDirectory)

setType

public void setType(CustomFieldType type)

setUnique

public void setUnique(boolean unique)

setValidationScript

public void setValidationScript(CustomScript validationScript)

setValidationScriptParameters

public void setValidationScriptParameters(java.lang.String validationScriptParameters)

setValueMatch

public void setValueMatch(ValueMatch valueMatch)