Package sk.iway.iwcm.components.customfields.rest

Class CustomFieldsService

java.lang.Object

sk.iway.iwcm.components.customfields.rest.CustomFieldsService

@Service
public class CustomFieldsService
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
static final Map<String,String>	BONUS_PARAMS

Constructor Summary

Constructors

Constructor	Description
CustomFieldsService(CustomFieldsRepository customFieldsRepository, EnumerationTypeRepository enumerationTypeRepository)

Method Summary

Modifier and Type	Method	Description
static CustomFieldsEntity	fromEntity(CustomFieldsEntity entity)	Parses the canonical string representation back into custom field properties.
List<String>	getClassOptions(String term)	Returns class name suggestions that contain the given search term.
static List<CustomFieldsEntity>	getCustomFields(CustomFieldsSearchDto main)	Retrieves custom fields for the given search context.
static List<CustomFieldsEntity>	getCustomFields(CustomFieldsSearchDto main, CustomFieldsSearchDto bonus)	Retrieves custom fields for the given main and bonus search contexts.
static Map<Character,CustomFieldsEntity>	getCustomFieldsMap(CustomFieldsSearchDto main)	Retrieves custom fields as a map indexed by their character alphabet key.
static List<LabelValue>	getFieldsTypes(Prop prop)	Returns all available custom field types with localized labels.
static String	getFieldTypeLabel(Prop prop, String fieldKey)	Retrieves the localized label for a custom field type.
static List<Character>	getRequiredFieldsAlphabets(CustomFieldsSearchDto main)	Retrieves the alphabet characters of required custom fields for the given context.
static List<Character>	getRequiredFieldsAlphabets(CustomFieldsSearchDto main, CustomFieldsSearchDto bonus)	Retrieves the alphabet characters of required custom fields for the given contexts.
static List<LabelValue>	getSpecificFieldVisibility()	Returns the mapping of field types to their type-specific property names.
static boolean	isEnumerationStringAlphabet(String alphabet)	Checks whether the alphabet value identifies a configurable enumeration string field.
static boolean	isSupportedFieldType(String type)	Checks whether a custom field type can be persisted by this service.
void	synchronizeSpecificClassFields(CustomFieldsEntity entity)	Applies class-specific derived values to a custom field configuration.
static CustomFieldsEntity	toEntity(CustomFieldsEntity entity)	Converts custom field configuration into its canonical string representation.
boolean	validateSpecificClass(CustomFieldsEntity entity, String action, org.springframework.validation.Errors errors, Long id, Prop prop)	Runs additional validation selected by the configured entity class name.

Methods inherited from class java.lang.Object

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

Field Details

BONUS_PARAMS

public static final Map<String,String> BONUS_PARAMS

Constructor Details

CustomFieldsService

@Autowired
public CustomFieldsService(CustomFieldsRepository customFieldsRepository,
 EnumerationTypeRepository enumerationTypeRepository)

Method Details

getCustomFieldsMap

public static Map<Character,CustomFieldsEntity> getCustomFieldsMap(CustomFieldsSearchDto main)

Retrieves custom fields as a map indexed by their character alphabet key.

Combines global fields (no entityId), specific entity fields, and bonus context fields with appropriate priority handling. Specific fields override global fields, and bonus fields have the highest priority.

Parameters:

main - the search context containing className and entityId

Returns:

map of custom fields indexed by their single-character alphabet key, or empty map if invalid params

See Also:

• getCustomFields(CustomFieldsSearchDto)

getCustomFields

public static List<CustomFieldsEntity> getCustomFields(CustomFieldsSearchDto main)

Retrieves custom fields for the given search context.

Fetches global fields (no entityId), specific entity fields, and bonus context fields when available. Specific fields override global fields, and bonus fields have the highest priority.

Parameters:

main - the search context containing className and entityId

Returns:

list of merged custom fields with priority handling, or empty list if invalid params

See Also:

• getCustomFields(CustomFieldsSearchDto, CustomFieldsSearchDto)

getCustomFields

public static List<CustomFieldsEntity> getCustomFields(CustomFieldsSearchDto main,
 CustomFieldsSearchDto bonus)

Retrieves custom fields for the given main and bonus search contexts.

Combines three field sources in priority order (lowest to highest):

1. Global fields - no entityId, apply to all entities of a class
2. Specific fields - have matching entityId, override global fields
3. Bonus fields - from bonus class context, have highest priority

Parameters:

main - primary search context with className and entityId

bonus - optional secondary context for bonus class fields; if null, only main context is used

Returns:

merged list of custom fields with priority-based deduplication, or empty list if invalid params

toEntity

public static CustomFieldsEntity toEntity(CustomFieldsEntity entity)

Converts custom field configuration into its canonical string representation.

Transforms entity properties into a structured value format based on field type:

• text: "text" or "text-{maxLength}" or "text-{maxLength}, warningLength-{warningLength}"
• select/multiselect: options string with optional leading | for non-required fields
• enumeration: "enumeration{_option1_option2}" with optional _null suffix
• docsIn: "docsIn_{groupId}" with optional _null suffix
• autocomplete: "autocomplete:{options}"
• json_group/json_doc: type name with optional _null suffix

Parameters:

entity - the custom field entity to convert

Returns:

the same entity with updated value field, never null

Throws:

IllegalStateException - if entity or its type is null/empty

See Also:

• fromEntity(CustomFieldsEntity)

fromEntity

public static CustomFieldsEntity fromEntity(CustomFieldsEntity entity)

Parses the canonical string representation back into custom field properties.

Reverse operation of toEntity(CustomFieldsEntity). Extracts type-specific properties from the value field:

• text: parses maxLength and warningLength from value
• select/multiselect: extracts selectOptions
• enumeration: parses enumeration options from underscore-separated format
• docsIn: resolves groupId to GroupDetails object
• autocomplete: extracts autocompleteOptions

Parameters:

entity - the custom field entity with populated value field

Returns:

the same entity with type-specific properties set, or original if type/value empty

See Also:

• toEntity(CustomFieldsEntity)

getFieldsTypes

public static List<LabelValue> getFieldsTypes(Prop prop)

Returns all available custom field types with localized labels.

Provides the complete list of supported field types for use in UI dropdowns or configuration interfaces. Labels are retrieved from the i18n property bundle using the key pattern "settings.custom-fields.type.{fieldType}".

Parameters:

prop - the property bundle for label localization

Returns:

list of LabelValue pairs with localized type names and their identifiers

See Also:

• getFieldTypeLabel(Prop, String)

isSupportedFieldType

public static boolean isSupportedFieldType(String type)

Checks whether a custom field type can be persisted by this service.

Parameters:

type - custom field type

Returns:

true for a supported field type

getFieldTypeLabel

public static String getFieldTypeLabel(Prop prop,
 String fieldKey)

Retrieves the localized label for a custom field type.

Parameters:

prop - the property bundle for label localization

fieldKey - the field type key (e.g., "text", "select", "enumeration")

Returns:

the localized label, retrieved using key "settings.custom-fields.type.{fieldKey}"

getSpecificFieldVisibility

public static List<LabelValue> getSpecificFieldVisibility()

Returns the mapping of field types to their type-specific property names.

Specifies which properties should be visible in the UI editor for each field type. Used to control which configuration options are shown when editing custom fields of different types.

Returns:

list of LabelValue pairs mapping field types to comma-separated property names

getRequiredFieldsAlphabets

public static List<Character> getRequiredFieldsAlphabets(CustomFieldsSearchDto main)

Retrieves the alphabet characters of required custom fields for the given context.

Returns only fields marked as required, extracting the first character from their alphabet identifier. Automatically derives bonus context when applicable.

Parameters:

main - the search context containing className and entityId

Returns:

list of single-character alphabet keys for required fields, or empty list if invalid params

See Also:

• getRequiredFieldsAlphabets(CustomFieldsSearchDto, CustomFieldsSearchDto)

getRequiredFieldsAlphabets

public static List<Character> getRequiredFieldsAlphabets(CustomFieldsSearchDto main,
 CustomFieldsSearchDto bonus)

Retrieves the alphabet characters of required custom fields for the given contexts.

Filters custom fields from both main and bonus contexts to return only those marked as required, extracting the first character from each field's alphabet identifier. Maintains insertion order via LinkedHashSet.

Parameters:

main - primary search context with className and entityId

bonus - optional secondary context for bonus class fields

Returns:

ordered list of single-character alphabet keys for required fields

See Also:

• getCustomFields(CustomFieldsSearchDto, CustomFieldsSearchDto)

validateSpecificClass

public boolean validateSpecificClass(CustomFieldsEntity entity,
 String action,
 org.springframework.validation.Errors errors,
 Long id,
 Prop prop)

Runs additional validation selected by the configured entity class name.

Parameters:

entity - custom field configuration

action - datatable editor action

errors - validation errors

id - custom field configuration ID

prop - current translations

Returns:

true when the class-specific validation passed or is not defined

synchronizeSpecificClassFields

public void synchronizeSpecificClassFields(CustomFieldsEntity entity)

Applies class-specific derived values to a custom field configuration.

Parameters:

entity - custom field configuration

isEnumerationStringAlphabet

public static boolean isEnumerationStringAlphabet(String alphabet)

Checks whether the alphabet value identifies a configurable enumeration string field.

Parameters:

alphabet - custom field alphabet value

Returns:

true for values A through L

getClassOptions

public List<String> getClassOptions(String term)

Returns class name suggestions that contain the given search term.

Parameters:

term - search text

Returns:

case-insensitively sorted list of matching class names