Interface ICustomAttributesEntity

All Superinterfaces:

ICustomAttributeProviding

All Known Implementing Classes:

ClientFormTheme, Mandant, Projekt, Textbaustein, Vorgang

public interface ICustomAttributesEntity
extends ICustomAttributeProviding

Interface for entities that store custom attributes, i.e. key-value pairs that can be used to store additional information. The stored data depends on the entity.

Since:

8.3.0

Author:

XIMA MEDIA GmbH

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ATTR_CUSTOM_ATTRIBUTES	JPA attribute name for the ICustomAttributeProviding.getCustomAttributes() field.
static final String	COL_CUSTOM_ATTRIBUTE_NAME	Database column name for the name of one of the ICustomAttributeProviding.getCustomAttributes().
static final String	COL_CUSTOM_ATTRIBUTE_VALUE	Database column name for the value of one of the ICustomAttributeProviding.getCustomAttributes().

Method Summary

Modifier and Type	Method	Description
default void	removeCustomAttribute(String key)	Removes the attribute with the given key. if present.
default void	setCustomAttribute(String key, String value)	Sets the value of the attribute with the given key to the given value.
default void	setCustomAttributeBoolean(String key, boolean value)	Sets the value of the attribute with the given key to the given boolean value.
default void	setCustomAttributeDouble(String key, double value)	Sets the value of the attribute with the given key to the given double value.
default void	setCustomAttributeEnum(String key, Enum<?> value)	Sets the value of the attribute with the given key to the given enum constant.
default void	setCustomAttributeInt(String key, int value)	Sets the value of the attribute with the given key to the given int value.
default void	setCustomAttributeJSONArray(String key, com.alibaba.fastjson.JSONArray value)	Sets the value of the attribute with the given key to the given JSON array.
default void	setCustomAttributeJSONObject(String key, com.alibaba.fastjson.JSONObject value)	Sets the value of the attribute with the given key to the given JSON object.
default void	setCustomAttributeLong(String key, long value)	Sets the value of the attribute with the given key to the given long value.
void	setCustomAttributes(Map<String,String> customAttributes)	Sets the map of custom attributes that may be used to store additional information.
default void	setCustomAttributeString(String key, String value)	Sets the value of the attribute with the given key to the given string value.
default void	setCustomAttributeUuid(String key, UUID value)	Sets the value of the attribute with the given key to the given UUID value.

Methods inherited from interface ICustomAttributeProviding

getCustomAttribute, getCustomAttributeAs, getCustomAttributeAs, getCustomAttributeBoolean, getCustomAttributeDouble, getCustomAttributeDouble, getCustomAttributeEnum, getCustomAttributeEnum, getCustomAttributeInt, getCustomAttributeInt, getCustomAttributeJsonArray, getCustomAttributeJsonObject, getCustomAttributeLong, getCustomAttributeLong, getCustomAttributes, getCustomAttributeString, getCustomAttributeString, getCustomAttributeUuid

Field Details

ATTR_CUSTOM_ATTRIBUTES

static final String ATTR_CUSTOM_ATTRIBUTES

JPA attribute name for the ICustomAttributeProviding.getCustomAttributes() field.

See Also:

• Constant Field Values

COL_CUSTOM_ATTRIBUTE_NAME

static final String COL_CUSTOM_ATTRIBUTE_NAME

Database column name for the name of one of the ICustomAttributeProviding.getCustomAttributes().

See Also:

• Constant Field Values

COL_CUSTOM_ATTRIBUTE_VALUE

static final String COL_CUSTOM_ATTRIBUTE_VALUE

Database column name for the value of one of the ICustomAttributeProviding.getCustomAttributes().

See Also:

• Constant Field Values

Method Details

removeCustomAttribute

default void removeCustomAttribute(String key)

Removes the attribute with the given key. if present.

Parameters:

key - Name of the attribute to remove.

setCustomAttribute

default void setCustomAttribute(String key,
 String value)

Sets the value of the attribute with the given key to the given value.

Parameters:

key - Name of the attribute.

value - New attribute value to set. Passing null will remove the attribute.

setCustomAttributeBoolean

default void setCustomAttributeBoolean(String key,
 boolean value)

Sets the value of the attribute with the given key to the given boolean value.

Parameters:

key - Name of the attribute.

value - New attribute value to set.

setCustomAttributeDouble

default void setCustomAttributeDouble(String key,
 double value)

Sets the value of the attribute with the given key to the given double value.

Parameters:

key - Name of the attribute.

value - New attribute value to set.

setCustomAttributeEnum

default void setCustomAttributeEnum(String key,
 Enum<?> value)

Sets the value of the attribute with the given key to the given enum constant.

Parameters:

key - Name of the attribute.

value - New attribute value to set. Passing null will remove the attribute.

setCustomAttributeInt

default void setCustomAttributeInt(String key,
 int value)

Sets the value of the attribute with the given key to the given int value.

Parameters:

key - Name of the attribute.

value - New attribute value to set.

setCustomAttributeJSONArray

default void setCustomAttributeJSONArray(String key,
 com.alibaba.fastjson.JSONArray value)

Sets the value of the attribute with the given key to the given JSON array.

Parameters:

key - Name of the attribute.

value - New attribute value to set. Passing null will remove the attribute.

setCustomAttributeJSONObject

default void setCustomAttributeJSONObject(String key,
 com.alibaba.fastjson.JSONObject value)

Sets the value of the attribute with the given key to the given JSON object.

Parameters:

key - Name of the attribute.

value - New attribute value to set. Passing null will remove the attribute.

setCustomAttributeLong

default void setCustomAttributeLong(String key,
 long value)

Sets the value of the attribute with the given key to the given long value.

Parameters:

key - Name of the attribute.

value - New attribute value to set.

setCustomAttributeString

default void setCustomAttributeString(String key,
 String value)

Sets the value of the attribute with the given key to the given string value.

Parameters:

key - Name of the attribute.

value - New attribute value to set. Passing null or empty string will remove the attribute.

setCustomAttributeUuid

default void setCustomAttributeUuid(String key,
 UUID value)

Sets the value of the attribute with the given key to the given UUID value.

Parameters:

key - Name of the attribute.

value - New attribute value to set. Passing null will remove the attribute.

setCustomAttributes

void setCustomAttributes(Map<String,String> customAttributes)

Sets the map of custom attributes that may be used to store additional information. The stored data depends on the type of the object.

Parameters:

customAttributes - The new custom attributes to set.