Package org.cyclos.impl.system

Interface CustomFieldValueHandler

public interface CustomFieldValueHandler

Handler for custom field values, containing shared methods for validations, search filters and so on

Field Summary

Fields

Modifier and Type	Field	Description
static String	ATTR_FIELD	Script attribute: the custom field being validated
static String	ATTR_OBJECT	Script attribute: the object being validated
static String	ATTR_VALUE	Script attribute: the current value being validated
static List<Property<?,?>>	SEARCH_PROPERTIES	The possible properties that hold actual values on CustomFieldValueForSearchDTO
static List<Property<?,?>>	VALUE_PROPERTIES	The possible properties that hold actual values on CustomFieldValueDTO

Method Summary

Modifier and Type	Method	Description
void	addLengthValidation(Property property, IntegerRange length)	Adds a length range validation on the given Property for the given IntegerRange.
void	addPatternValidation(Property property, String pattern)	Adds an input with pattern validation on the given Property for the given pattern.
Property	addValueValidation(Validator validator, CustomField<?,?,?> field, com.querydsl.core.types.dsl.EntityPathBase<? extends CustomFieldValue<?,?,?,?>> fv, Map<String,?> dynamicValueBindings)	Adds a validation on the given Validator for the given CustomField
Property	addValueValidation(Validator validator, CustomField<?,?,?> field, com.querydsl.core.types.dsl.EntityPathBase<? extends CustomFieldValue<?,?,?,?>> fv, Map<String,?> dynamicValueBindings, String valuesProperty)	Adds a validation on the given Validator for the given CustomField, using a custom values collection
Property	addValueValidation(Validator validator, CustomField<?,?,?> field, com.querydsl.core.types.dsl.EntityPathBase<? extends CustomFieldValue<?,?,?,?>> fv, Map<String,?> dynamicValueBindings, LoadValuesScriptFunction dynamicValueValidationFunction, String valuesProperty)	Adds a validation on the given Validator for the given CustomField, using a custom values collection
Property	addValueValidationAsProperty(Validator validator, CustomField<?,?,?> field, com.querydsl.core.types.dsl.EntityPathBase<? extends CustomFieldValue<?,?,?,?>> fv, Map<String,?> dynamicValueBindings, Property<?,?> valueProperty)	Adds a validation to a custom field that reports itself in the ValidationError as a property, not as a custom field
Property	addValueValidationAsPropertyIgnoringRequired(Validator validator, CustomField<?,?,?> field, com.querydsl.core.types.dsl.EntityPathBase<? extends CustomFieldValue<?,?,?,?>> fv, Map<String,?> dynamicValueBindings, Property<?,?> valueProperty)	Adds a validation to a custom field that reports itself in the ValidationError as a property, not as a custom field, ignoring the required validation
Property	addValueValidationIgnoringRequired(Validator validator, CustomField<?,?,?> field, com.querydsl.core.types.dsl.EntityPathBase<? extends CustomFieldValue<?,?,?,?>> fv, Map<String,?> dynamicValueBindings)	Adds a validation on the given Validator for the given CustomField, ignoring required validations
void	addWordSizeValidation(Property property, CustomField<?,?,?> field)	Adds a word size validation on the given Property. A larger default size will be applied for TEXT and URL.
<CF extends CustomField<CF,C,PV>,C extends CustomFieldPossibleValueCategory<CF,C,PV>,PV extends CustomFieldPossibleValue<CF,C,PV>,V extends CustomFieldValue<CF,C,PV,O>,O extends SimpleEntity & EntityWithCustomValues<CF,C,PV,V>> V	buildFieldValue(CF field, Class<V> valueType, QCustomFieldValue fv, com.querydsl.core.Tuple tuple)	Builds a field value from a projected custom field.
<CF extends CustomField<CF,C,PV>,C extends CustomFieldPossibleValueCategory<CF,C,PV>,PV extends CustomFieldPossibleValue<CF,C,PV>,V extends CustomFieldValue<CF,C,PV,E>,E extends SimpleEntity & EntityWithCustomValues<CF,C,PV,V>> List<V>	cloneCustomValuesData(E owner, Collection<V> values)	Clones a collection of CustomFieldValue managing the special cases: CustomFieldType.FILE and CustomFieldType.IMAGE, i.e cloning the associated CustomFieldValueFile and CustomFieldValueImage entities too. This method offers the same support as cloneCustomValuesData(ModelWithCustomValues, Collection) but for entities.
<CF extends CustomField<CF,C,PV>,C extends CustomFieldPossibleValueCategory<CF,C,PV>,PV extends CustomFieldPossibleValue<CF,C,PV>,V extends CustomFieldValue<CF,C,PV,E>,E extends SimpleEntity & EntityWithCustomValues<CF,C,PV,V>> void	cloneCustomValuesData(ModelWithCustomValues<CustomFieldValueDTO> model, Collection<V> values)	Converts a collection of CustomFieldValue to a collection if CustomFieldValueDTOs and set it in the given model container but cloning the related custom field value's data.
void	fillValuesFromScript(Class<? extends CustomField<?,?,?>> fieldType, LoadValuesScriptFunction function, Map<String,?> variables, Collection<? extends CustomFieldDetailedVO> vos)	Fills in the given CustomFieldDetailedVOs using values generated from script.
void	fillValuesFromScript(Class<? extends CustomField<?,?,?>> fieldType, LoadValuesScriptFunction function, Map<String,?> variables, Collection<? extends CustomFieldDetailedVO> vos, boolean forBulkAction)	Fills in the given CustomFieldDetailedVOs using values generated from script.
String	format(FormatterImpl formatter, CustomField<?,?,?> field, Object value)	Formats the given value according to the custom field definitions, returning an empty string for null value
CustomField<?,?,?>	getCustomField(CustomFieldVO vo)	Converts the given CustomFieldVO to the corresponding CustomField The CustomFieldVO parameter must have set the corresponding field's nature.
static Class<? extends CustomField<?,?,?>>	getCustomFieldClass(CustomFieldNature nature)	Returns the CustomField'class for the given nature.
static CustomFieldNature	getCustomFieldNature(Class<? extends CustomField<?,?,?>> clazz)	Returns the CustomFieldNature for the given class.
Object	getDefaultValue(CustomField<?,?,?> field)	Returns the actual default value for this field.
Set<com.querydsl.core.types.Path<?>>	getProjectionPaths(CustomField<?,?,?> field, QCustomFieldValue fv)	Returns the paths that should be projected for the given custom field
Object	getValue(CustomField<?,?,?> field, Object value, boolean sanitize)	Calls getValue(CustomField, Object, boolean, FormatterImpl) with no formatter, meaning dates / numbers as string will use the standard format, not a user-defined format
Object	getValue(CustomField<?,?,?> field, Object value, boolean sanitize, FormatterImpl formatter)	Returns the value (as entities when possible) for the given custom field value.
Object	getValueForSearch(CustomField<?,?,?> field, Object value, boolean nativeValue)	Returns the value used to filter when the given custom field is used as a search filter. If the parameter nativeValue is true then the result will be as close to the database as possible, depending on the custom field type.
Class<?>	getValueType(CustomField<?,?,?> field)	Returns the type of actual values this field has, according to the field type: CustomFieldType.STRING, CustomFieldType.TEXT, CustomFieldType.RICH_TEXT or CustomFieldType.URL: String; CustomFieldType.BOOLEAN: Boolean; CustomFieldType.INTEGER: Integer; CustomFieldType.DECIMAL: BigDecimal; CustomFieldType.DATE: Date; CustomFieldType.SINGLE_SELECTION: the proper subclass of CustomFieldPossibleValue; CustomFieldType.MULTI_SELECTION: Set of the proper subclass of CustomFieldPossibleValue;; CustomFieldType.DYNAMIC_SELECTION: DynamicFieldValue; CustomFieldType.DYNAMIC_MULTI_SELECTION: Set of DynamicFieldValue; CustomFieldType.FILE: RawFile; CustomFieldType.IMAGE: Image; CustomFieldType.LINKED_ENTITY: Depends on the linked entity type: LinkedEntityType.USER: User; LinkedEntityType.RECORD: Record; LinkedEntityType.ADVERTISEMENT: BasicAd; LinkedEntityType.TRANSACTION: Transaction; LinkedEntityType.TRANSFER: Transfer;
void	processAfterSave(EntityWithCustomValues<?,?,?,?> entity)	Process actions over custom fields that require the entity to be saved first.
com.querydsl.core.types.Predicate	queryFilter(com.querydsl.core.types.EntityPath<? extends CustomFieldValue<?,?,?,?>> valuePath, CustomField<?,?,?> customField, CustomFieldValueForSearchDTO valueForSearch)	Returns a predicate which represents the condition for the given custom field and value path for the given custom field search value, or null if no query criteria specified
void	remove(CustomFieldValue<?,?,?,?> fieldValue)	Removes the given field value, properly removing any stored files for binary fields
void	removeAll(EntityWithCustomValues<?,?,?,?> owner)	Removes all custom fields of the given owner, taking care to properly remove any stored files for binary fields.
Set<CustomFieldValueForSearchDTO>	resolveDefaultSearchValues(Collection<CustomFieldDetailedVO> fields)	Fill the query with possible values marked as default on search
Object	resolveReference(CustomField<?,?,?> field, String value, boolean unmaskIds, boolean sanitize, FormatterImpl formatter, String valueSeparator)	Resolve a reference to a value, returning a "server-side", normalized representation of the value.
<DTO extends CustomFieldValueDTO> List<DTO>	resolveValues(Class<? extends CustomField<?,?,?>> customFieldType, Collection<DTO> valueDTOs)	Makes sure all values set in the given DTOs collection are correctly filled-in, so it can be sent back to clients with complete data.
<CF extends CustomField<CF,C,PV>,C extends CustomFieldPossibleValueCategory<CF,C,PV>,PV extends CustomFieldPossibleValue<CF,C,PV>,V extends CustomFieldValue<CF,C,PV,E>,E extends SimpleEntity & EntityWithCustomValues<CF,C,PV,V>> void	setCustomValues(E entity, Collection<CF> enabledFields, Collection<CF> editable, Collection<CustomFieldValueDTO> fieldValueDTOs)	Saves the custom values from DTOs to the given entity
void	setCustomValues(BasicUser user, Collection<UserCustomField> enabledFields, Collection<UserCustomField> editable, Collection<UserCustomField> managePrivacy, Collection<UserCustomFieldValueDTO> fieldValueDTOs)	Saves the custom values from DTOs to the given user
void	setDefaultValue(CustomFieldDetailedVO vo, Object defaultValue)	Sets the default field value to the given value
<DTO extends CustomFieldValueDTO> void	setDefaultValues(List<? extends CustomFieldDetailedVO> fields, ModelWithCustomValues<DTO> model, Function<CustomFieldDetailedVO,DTO> factory)	Ensure the values list has the default value for each field.
default void	setDefaultValues(List<? extends CustomFieldDetailedVO> fields, ModelWithCustomValues<CustomFieldValueDTO> model)
<CF extends CustomField<CF,C,PV>,C extends CustomFieldPossibleValueCategory<CF,C,PV>,PV extends CustomFieldPossibleValue<CF,C,PV>,V extends CustomFieldValue<CF,C,PV,O>,O extends SimpleEntity & EntityWithCustomValues<CF,C,PV,V>> void	setDefaultValues(O entity, Collection<CF> fields)	Adds a custom field value with the field's default value only if it is not present in the given entity for each field in the list. This method is a shortcut for addDefaultValues(SimpleEntity, Collection, Collection) passing entity.getCustomValues() as the custom values. NOTE: This method shouldn't be used if the entity will be converted to DTO, instead, use setDefaultValues(List, ModelWithCustomValues, Function) to set the defaults directly to the DTO.
void	setModelValue(CustomField<?,?,?> customField, Object value, ICustomFieldValue<?,?,?,?> fieldValue)	Sets the given value on the given ICustomFieldValue, according to the correct type, converting the value to the model-specific type.
void	sortAndRemoveMissing(List<? extends CustomFieldValueDTO> customValues, List<? extends IEntity> allowedFields)	Sorts the given list of CustomFieldValueDTO and remove a value if it's for a field not present in the given list of allowed fields (i.e.
void	sortAndRemoveMissingFromVO(List<? extends CustomFieldValueVO> customValues, List<? extends IEntity> allowedFields)	Same as sortAndRemoveMissing(List, List) but for a list of VOs
List<? extends CustomFieldPossibleValue<?,?,?>>	toCustomFieldPossibleValues(CustomField<?,?,?> customField, Collection<?> values)	Converts each of the given input value to a custom field possible value of the given field
List<SimpleEntity>	toLinkedEntityValues(CustomField<?,?,?> customField, Collection<?> values)	Convert each of the given input value to a linked entity suited for the given custom field
String	toReference(CustomField<?,?,?> field, Object value)	Converts the given field value to a valid reference value
<CF extends CustomField<CF,?,?>> SortedMap<CF,Object>	toSearchFiltersMap(Collection<CF> customFields, Collection<? extends CustomFieldValueForSearchDTO> fieldValues, boolean sanitize)	Returns a map keyed by custom fields, whose values are the values for search of each field
<CF extends CustomField<CF,?,?>> SortedMap<CF,Object>	toValuesMap(Collection<CF> customFields, Collection<? extends ICustomFieldValue<?,?,?,?>> fieldValues, boolean sanitize)	Returns a map keyed by custom fields, whose values are the values of each field

Field Detail

ATTR_OBJECT

static final String ATTR_OBJECT

Script attribute: the object being validated

See Also:

Constant Field Values

ATTR_FIELD

static final String ATTR_FIELD

Script attribute: the custom field being validated

See Also:

Constant Field Values

ATTR_VALUE

static final String ATTR_VALUE

Script attribute: the current value being validated

See Also:

Constant Field Values

VALUE_PROPERTIES

static final List<Property<?,?>> VALUE_PROPERTIES

The possible properties that hold actual values on CustomFieldValueDTO

SEARCH_PROPERTIES

static final List<Property<?,?>> SEARCH_PROPERTIES

The possible properties that hold actual values on CustomFieldValueForSearchDTO

Method Detail

getCustomFieldClass

static Class<? extends CustomField<?,?,?>> getCustomFieldClass(CustomFieldNature nature)

Returns the CustomField'class for the given nature.

Throws:

IllegalArgumentException - for unknown natures

getCustomFieldNature

static CustomFieldNature getCustomFieldNature(Class<? extends CustomField<?,?,?>> clazz)

Returns the CustomFieldNature for the given class.

Throws:

IllegalArgumentException - for unknown class

addLengthValidation

void addLengthValidation(Property property,
                         IntegerRange length)

Adds a length range validation on the given Property for the given IntegerRange. If the length parameter is null then it returns without changes.

addPatternValidation

void addPatternValidation(Property property,
                          String pattern)

Adds an input with pattern validation on the given Property for the given pattern. If the pattern parameter is empty (or null) then it returns without changes.

addValueValidation

Property addValueValidation(Validator validator,
                            CustomField<?,?,?> field,
                            com.querydsl.core.types.dsl.EntityPathBase<? extends CustomFieldValue<?,?,?,?>> fv,
                            Map<String,?> dynamicValueBindings)

Adds a validation on the given Validator for the given CustomField

addValueValidation

Property addValueValidation(Validator validator,
                            CustomField<?,?,?> field,
                            com.querydsl.core.types.dsl.EntityPathBase<? extends CustomFieldValue<?,?,?,?>> fv,
                            Map<String,?> dynamicValueBindings,
                            LoadValuesScriptFunction dynamicValueValidationFunction,
                            String valuesProperty)

Adds a validation on the given Validator for the given CustomField, using a custom values collection

addValueValidation

Property addValueValidation(Validator validator,
                            CustomField<?,?,?> field,
                            com.querydsl.core.types.dsl.EntityPathBase<? extends CustomFieldValue<?,?,?,?>> fv,
                            Map<String,?> dynamicValueBindings,
                            String valuesProperty)

Adds a validation on the given Validator for the given CustomField, using a custom values collection

addValueValidationAsProperty

Property addValueValidationAsProperty(Validator validator,
                                      CustomField<?,?,?> field,
                                      com.querydsl.core.types.dsl.EntityPathBase<? extends CustomFieldValue<?,?,?,?>> fv,
                                      Map<String,?> dynamicValueBindings,
                                      Property<?,?> valueProperty)

Adds a validation to a custom field that reports itself in the ValidationError as a property, not as a custom field

addValueValidationAsPropertyIgnoringRequired

Property addValueValidationAsPropertyIgnoringRequired(Validator validator,
                                                      CustomField<?,?,?> field,
                                                      com.querydsl.core.types.dsl.EntityPathBase<? extends CustomFieldValue<?,?,?,?>> fv,
                                                      Map<String,?> dynamicValueBindings,
                                                      Property<?,?> valueProperty)

Adds a validation to a custom field that reports itself in the ValidationError as a property, not as a custom field, ignoring the required validation

addValueValidationIgnoringRequired

Property addValueValidationIgnoringRequired(Validator validator,
                                            CustomField<?,?,?> field,
                                            com.querydsl.core.types.dsl.EntityPathBase<? extends CustomFieldValue<?,?,?,?>> fv,
                                            Map<String,?> dynamicValueBindings)

Adds a validation on the given Validator for the given CustomField, ignoring required validations

addWordSizeValidation

void addWordSizeValidation(Property property,
                           CustomField<?,?,?> field)

Adds a word size validation on the given Property.
A larger default size will be applied for TEXT and URL. and a smaller for STRING types

buildFieldValue

<CF extends CustomField<CF,C,PV>,C extends CustomFieldPossibleValueCategory<CF,C,PV>,PV extends CustomFieldPossibleValue<CF,C,PV>,V extends CustomFieldValue<CF,C,PV,O>,O extends SimpleEntity & EntityWithCustomValues<CF,C,PV,V>> V buildFieldValue(CF field,
                                                                                                                                                                                                                                                                                                                                                      Class<V> valueType,
                                                                                                                                                                                                                                                                                                                                                      QCustomFieldValue fv,
                                                                                                                                                                                                                                                                                                                                                      com.querydsl.core.Tuple tuple)

Builds a field value from a projected custom field. Important: The returned value may be incomplete, and is only meant to be displayed. For example, the owner reference is not filled-in. If the given tuple contains a null id for the custom field value it returns null.

cloneCustomValuesData

<CF extends CustomField<CF,C,PV>,C extends CustomFieldPossibleValueCategory<CF,C,PV>,PV extends CustomFieldPossibleValue<CF,C,PV>,V extends CustomFieldValue<CF,C,PV,E>,E extends SimpleEntity & EntityWithCustomValues<CF,C,PV,V>> List<V> cloneCustomValuesData(E owner,
                                                                                                                                                                                                                                                                                                                                                                  Collection<V> values)

Clones a collection of CustomFieldValue managing the special cases: CustomFieldType.FILE and CustomFieldType.IMAGE, i.e cloning the associated CustomFieldValueFile and CustomFieldValueImage entities too.
This method offers the same support as cloneCustomValuesData(ModelWithCustomValues, Collection) but for entities.

Returns:

A list with the clones.
NOTE: This method can potentially create new entities that will be persisted then it must be used in a TransactionLevel.READ_WRITE transaction.

cloneCustomValuesData

<CF extends CustomField<CF,C,PV>,C extends CustomFieldPossibleValueCategory<CF,C,PV>,PV extends CustomFieldPossibleValue<CF,C,PV>,V extends CustomFieldValue<CF,C,PV,E>,E extends SimpleEntity & EntityWithCustomValues<CF,C,PV,V>> void cloneCustomValuesData(ModelWithCustomValues<CustomFieldValueDTO> model,
                                                                                                                                                                                                                                                                                                                                                               Collection<V> values)

Converts a collection of CustomFieldValue to a collection if CustomFieldValueDTOs and set it in the given model container but cloning the related custom field value's data. More specifically it clones the CustomFieldValueFile and CustomFieldValueImage, if any, for the corresponding custom field of type CustomFieldType.FILE or CustomFieldType.IMAGE.

NOTE: This method can potentially create new DTOs that will be persisted then it must be used in a TransactionLevel.READ_WRITE transaction.

fillValuesFromScript

void fillValuesFromScript(Class<? extends CustomField<?,?,?>> fieldType,
                          LoadValuesScriptFunction function,
                          Map<String,?> variables,
                          Collection<? extends CustomFieldDetailedVO> vos)

Fills in the given CustomFieldDetailedVOs using values generated from script. For supported custom field types, call the script of type ScriptType.LOAD_CUSTOM_FIELD_VALUES. For other custom field types, do nothing.

Parameters:

fieldType - The actual custom field class, required to load the proper entities

function - The function to call. May be called in the context of an entity or a search

vos - The list of CustomFieldDetailedVO which will be processed

variables - Variables to be bound to the script context

fillValuesFromScript

void fillValuesFromScript(Class<? extends CustomField<?,?,?>> fieldType,
                          LoadValuesScriptFunction function,
                          Map<String,?> variables,
                          Collection<? extends CustomFieldDetailedVO> vos,
                          boolean forBulkAction)

Fills in the given CustomFieldDetailedVOs using values generated from script. For supported custom field types, call the script of type ScriptType.LOAD_CUSTOM_FIELD_VALUES. For other custom field types, do nothing.

Parameters:

fieldType - The actual custom field class, required to load the proper entities

function - The function to call. May be called in the context of an entity or a search

vos - The list of CustomFieldDetailedVO which will be processed

variables - Variables to be bound to the script context

forBulkAction - True if the values are filled for a bulk action

format

String format(FormatterImpl formatter,
              CustomField<?,?,?> field,
              Object value)

Formats the given value according to the custom field definitions, returning an empty string for null value

getCustomField

CustomField<?,?,?> getCustomField(CustomFieldVO vo)

Converts the given CustomFieldVO to the corresponding CustomField The CustomFieldVO parameter must have set the corresponding field's nature.

getDefaultValue

Object getDefaultValue(CustomField<?,?,?> field)

Returns the actual default value for this field. The type of the resulting object will be the same as getValueType(CustomField).

getProjectionPaths

Set<com.querydsl.core.types.Path<?>> getProjectionPaths(CustomField<?,?,?> field,
                                                        QCustomFieldValue fv)

Returns the paths that should be projected for the given custom field

getValue

Object getValue(CustomField<?,?,?> field,
                Object value,
                boolean sanitize)

Calls getValue(CustomField, Object, boolean, FormatterImpl) with no formatter, meaning dates / numbers as string will use the standard format, not a user-defined format

getValue

Object getValue(CustomField<?,?,?> field,
                Object value,
                boolean sanitize,
                FormatterImpl formatter)

Returns the value (as entities when possible) for the given custom field value. The type of the resulting object will be the same as getValueType(CustomField). If the value is a string and a formatter is given, will use the formatter to parse the string, instead of assuming the standard formats

Parameters:

field - The custom field

value - The value to resolve from. Can either be a ICustomFieldValue or a scalar value, which will be converted to the corresponding type

sanitize - Indicates if text should be sanitized. Should be set to true when reading text from clients, and false when reading data from the database.

formatter - If null, dates / numbers parsed from string will be assumed in the standard format. If not null, is used to parse.

getValueForSearch

Object getValueForSearch(CustomField<?,?,?> field,
                         Object value,
                         boolean nativeValue)

Returns the value used to filter when the given custom field is used as a search filter.
If the parameter nativeValue is true then the result will be as close to the database as possible, depending on the custom field type. No empty collections are returned. So, it is safe to assume that if the result is not null, it will be used on the query.

The possible returned types are:

• CustomFieldType.STRING, CustomFieldType.TEXT, CustomFieldType.RICH_TEXT or CustomFieldType.URL: String. If nativeValue is true and the field uses a pattern (mask) then it is removed from the input value. Otherwise return the input value;
• CustomFieldType.BOOLEAN: Boolean;
• CustomFieldType.INTEGER: IntegerRange;
• CustomFieldType.DECIMAL: DecimalRange;
• CustomFieldType.DATE: DateRange;
• CustomFieldType.SINGLE_SELECTION or CustomFieldType.MULTI_SELECTION: If nativeValue is true then Set of Longs (ids). Otherwise Set of CustomFieldPossibleValues;
• CustomFieldType.DYNAMIC_SELECTION: If nativeValue is true then either a String when applying a fulltext search with the dynamic value's label or a Set of Strings when need to do exact matching against the internal value. Otherwise either the input value when applying a fulltext or a Set of Strings with the label of the values when need to do exact matching;
• CustomFieldType.LINKED_ENTITY: If nativeValue is true then Set of Longs (ids). Otherwise Set of SimpleEntitys;
• CustomFieldType.FILE or CustomFieldType.IMAGE: null (those are not supported for filter);

Parameters:

field - The custom field

value - The value to resolve from. Can either be a BaseValueForSearchDTO or a scalar value

nativeValue - true when the result will be used as filter in the query send to the database.

Returns:

The value for search converted to the specific type

getValueType

Class<?> getValueType(CustomField<?,?,?> field)

Returns the type of actual values this field has, according to the field type:

• CustomFieldType.STRING, CustomFieldType.TEXT, CustomFieldType.RICH_TEXT or CustomFieldType.URL: String;
• CustomFieldType.BOOLEAN: Boolean;
• CustomFieldType.INTEGER: Integer;
• CustomFieldType.DECIMAL: BigDecimal;
• CustomFieldType.DATE: Date;
• CustomFieldType.SINGLE_SELECTION: the proper subclass of CustomFieldPossibleValue;
• CustomFieldType.MULTI_SELECTION: Set of the proper subclass of CustomFieldPossibleValue;
;
• CustomFieldType.DYNAMIC_SELECTION: DynamicFieldValue;
• CustomFieldType.DYNAMIC_MULTI_SELECTION: Set of DynamicFieldValue;
• CustomFieldType.FILE: RawFile;
• CustomFieldType.IMAGE: Image;
• CustomFieldType.LINKED_ENTITY: Depends on the linked entity type:
  • LinkedEntityType.USER: User;
  • LinkedEntityType.RECORD: Record;
  • LinkedEntityType.ADVERTISEMENT: BasicAd;
  • LinkedEntityType.TRANSACTION: Transaction;
  • LinkedEntityType.TRANSFER: Transfer;

processAfterSave

void processAfterSave(EntityWithCustomValues<?,?,?,?> entity)

Process actions over custom fields that require the entity to be saved first. For example, temporary files / images are moved to the the final fileValues / imageValues fields.

queryFilter

com.querydsl.core.types.Predicate queryFilter(com.querydsl.core.types.EntityPath<? extends CustomFieldValue<?,?,?,?>> valuePath,
                                              CustomField<?,?,?> customField,
                                              CustomFieldValueForSearchDTO valueForSearch)

Returns a predicate which represents the condition for the given custom field and value path for the given custom field search value, or null if no query criteria specified

remove

void remove(CustomFieldValue<?,?,?,?> fieldValue)

Removes the given field value, properly removing any stored files for binary fields

removeAll

void removeAll(EntityWithCustomValues<?,?,?,?> owner)

Removes all custom fields of the given owner, taking care to properly remove any stored files for binary fields.

resolveDefaultSearchValues

Set<CustomFieldValueForSearchDTO> resolveDefaultSearchValues(Collection<CustomFieldDetailedVO> fields)

Fill the query with possible values marked as default on search

resolveReference

Object resolveReference(CustomField<?,?,?> field,
                        String value,
                        boolean unmaskIds,
                        boolean sanitize,
                        FormatterImpl formatter,
                        String valueSeparator)

Resolve a reference to a value, returning a "server-side", normalized representation of the value.

See Also:

getValueType(CustomField)

resolveValues

<DTO extends CustomFieldValueDTO> List<DTO> resolveValues(Class<? extends CustomField<?,?,?>> customFieldType,
                                                          Collection<DTO> valueDTOs)

Makes sure all values set in the given DTOs collection are correctly filled-in, so it can be sent back to clients with complete data. For example, if a value has the id or reference to a linked entity, it will have the correct LinkedEntityVO set with display. The same applies to enumerated values or dynamic values. Important: The use case for this method is the case where a DTO with custom values is sent from client to server,then those values are sent back to the clients. Hence, no sanitization is performed on strings, because these strings will be sent back from the client to server later, and that would make the string be sanitized twice, which can make them invalid.

Returns:

a new ordered list of custom values according to the fields order.

setCustomValues

void setCustomValues(BasicUser user,
                     Collection<UserCustomField> enabledFields,
                     Collection<UserCustomField> editable,
                     Collection<UserCustomField> managePrivacy,
                     Collection<UserCustomFieldValueDTO> fieldValueDTOs)

Saves the custom values from DTOs to the given user

setCustomValues

<CF extends CustomField<CF,C,PV>,C extends CustomFieldPossibleValueCategory<CF,C,PV>,PV extends CustomFieldPossibleValue<CF,C,PV>,V extends CustomFieldValue<CF,C,PV,E>,E extends SimpleEntity & EntityWithCustomValues<CF,C,PV,V>> void setCustomValues(E entity,
                                                                                                                                                                                                                                                                                                                                                         Collection<CF> enabledFields,
                                                                                                                                                                                                                                                                                                                                                         Collection<CF> editable,
                                                                                                                                                                                                                                                                                                                                                         Collection<CustomFieldValueDTO> fieldValueDTOs)

Saves the custom values from DTOs to the given entity

setDefaultValue

void setDefaultValue(CustomFieldDetailedVO vo,
                     Object defaultValue)

Sets the default field value to the given value

setDefaultValues

default void setDefaultValues(List<? extends CustomFieldDetailedVO> fields,
                              ModelWithCustomValues<CustomFieldValueDTO> model)

setDefaultValues

<DTO extends CustomFieldValueDTO> void setDefaultValues(List<? extends CustomFieldDetailedVO> fields,
                                                        ModelWithCustomValues<DTO> model,
                                                        Function<CustomFieldDetailedVO,DTO> factory)

Ensure the values list has the default value for each field.

setDefaultValues

<CF extends CustomField<CF,C,PV>,C extends CustomFieldPossibleValueCategory<CF,C,PV>,PV extends CustomFieldPossibleValue<CF,C,PV>,V extends CustomFieldValue<CF,C,PV,O>,O extends SimpleEntity & EntityWithCustomValues<CF,C,PV,V>> void setDefaultValues(O entity,
                                                                                                                                                                                                                                                                                                                                                          Collection<CF> fields)

Adds a custom field value with the field's default value only if it is not present in the given entity for each field in the list.
This method is a shortcut for addDefaultValues(SimpleEntity, Collection, Collection) passing entity.getCustomValues() as the custom values.

NOTE: This method shouldn't be used if the entity will be converted to DTO, instead, use setDefaultValues(List, ModelWithCustomValues, Function) to set the defaults directly to the DTO. Setting the defaults directly to the entity has the limitation of losing the defaults for the dynamic custom fields because we need to run the associated script but we can't construct the required variables.

setModelValue

void setModelValue(CustomField<?,?,?> customField,
                   Object value,
                   ICustomFieldValue<?,?,?,?> fieldValue)

Sets the given value on the given ICustomFieldValue, according to the correct type, converting the value to the model-specific type. For example, enumerated values as CustomFieldPossibleValueVO, dates as DateTime, etc.

sortAndRemoveMissing

void sortAndRemoveMissing(List<? extends CustomFieldValueDTO> customValues,
                          List<? extends IEntity> allowedFields)

Sorts the given list of CustomFieldValueDTO and remove a value if it's for a field not present in the given list of allowed fields (i.e. the catalog).

Parameters:

customValues - the list of values to sort.

allowedFields - the ordered list of allowed fields.

sortAndRemoveMissingFromVO

void sortAndRemoveMissingFromVO(List<? extends CustomFieldValueVO> customValues,
                                List<? extends IEntity> allowedFields)

Same as sortAndRemoveMissing(List, List) but for a list of VOs

See Also:

sortAndRemoveMissing(List, List)

toCustomFieldPossibleValues

List<? extends CustomFieldPossibleValue<?,?,?>> toCustomFieldPossibleValues(CustomField<?,?,?> customField,
                                                                                        Collection<?> values)

Converts each of the given input value to a custom field possible value of the given field

toLinkedEntityValues

List<SimpleEntity> toLinkedEntityValues(CustomField<?,?,?> customField,
                                        Collection<?> values)

Convert each of the given input value to a linked entity suited for the given custom field

toReference

String toReference(CustomField<?,?,?> field,
                   Object value)

Converts the given field value to a valid reference value

toSearchFiltersMap

<CF extends CustomField<CF,?,?>> SortedMap<CF,Object> toSearchFiltersMap(Collection<CF> customFields,
                                                                                           Collection<? extends CustomFieldValueForSearchDTO> fieldValues,
                                                                                           boolean sanitize)

Returns a map keyed by custom fields, whose values are the values for search of each field

toValuesMap

<CF extends CustomField<CF,?,?>> SortedMap<CF,Object> toValuesMap(Collection<CF> customFields,
                                                                                    Collection<? extends ICustomFieldValue<?,?,?,?>> fieldValues,
                                                                                    boolean sanitize)

Returns a map keyed by custom fields, whose values are the values of each field