Package de.xima.fc.entities

Class Textbaustein

java.lang.Object

de.xima.cmn.dao.model.AEntity<Long>

de.xima.fc.entities.AbstractEntity

de.xima.fc.entities.AbstractLockableEntity

de.xima.fc.entities.ALockableEntity

de.xima.fc.entities.AClientDependentEntity

de.xima.fc.entities.Textbaustein

All Implemented Interfaces:

de.xima.cmn.dao.interfaces.IEntity<Long>, de.xima.cmn.dao.interfaces.ILockableEntity<Long>, ICustomAttributeProviding, ICustomAttributesEntity, IDescriptionProviding, ILockingVersionProviding, IMandantDependent, INameProviding, ITransferable, ITransferableEntity, ITransferableLockableEntity, IUUIDEntity, Serializable, Comparable<de.xima.cmn.dao.interfaces.IEntity<Long>>

@Entity
public class Textbaustein
extends AClientDependentEntity
implements INameProviding, IDescriptionProviding, IUUIDEntity, ICustomAttributesEntity

Diese Entität ermöglicht eine Zuordnung zw. einem Schlüssselwort und einem dahinterliegenden Text. Zudem werden diese in verschiedene Kategorien aufgeteilt, so dass bspw. in Mails oder Weiterleitung unterteilt werden kann.

Author:

XIMA MEDIA GmbH

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static String	ATTR_CUSTOM_ATTRIBUTES	JPA attribute name for the getCustomAttributes() field.
static String	ATTR_DELETABLE	JPA attribute name for the isDeletable() field.
static String	ATTR_DEPRECATED	JPA attribute name for the isDeprecated() field.
static String	ATTR_KATEGORIE	JPA attribute name for the getKategorie() field.
static String	ATTR_KEYWORDS	JPA attribute name for the getKeywords() field.
static String	ATTR_MSGCODE	JPA attribute name for the getMsgCode() field.
static String	ATTR_SYSTEM	JPA attribute name for the isSystem() field.
static String	ATTR_TEXT_VALUE	JPA attribute name for the getTextValue() field.
static String	COL_UUID	Database column name for the getUUIDObject() field.

Fields inherited from class de.xima.fc.entities.AClientDependentEntity

COL_CLIENTID, mandant

Fields inherited from class de.xima.fc.entities.AbstractLockableEntity

COL_LOCKINGVERSION, lockingVersion

Fields inherited from class de.xima.fc.entities.AbstractEntity

COL_ID, id

Fields inherited from interface de.xima.fc.entities.interfaces.ICustomAttributesEntity

COL_CUSTOM_ATTRIBUTE_NAME, COL_CUSTOM_ATTRIBUTE_VALUE

Fields inherited from interface de.xima.fc.entities.interfaces.IDescriptionProviding

ATTR_BESCHREIBUNG, ATTR_DESCRIPTION, COL_DESCRIPTION

Fields inherited from interface de.xima.cmn.dao.interfaces.IEntity

ATTR_ID

Fields inherited from interface de.xima.cmn.dao.interfaces.ILockableEntity

ATTR_LOCKINGVERSION

Fields inherited from interface de.xima.fc.entities.interfaces.IMandantDependent

ATTR_CLIENT, ATTR_MANDANT, COL_CLIENT_ID

Fields inherited from interface de.xima.fc.entities.interfaces.INameProviding

ATTR_NAME, COL_NAME

Fields inherited from interface de.xima.fc.entities.interfaces.ITransferableEntity

IMPORT_ID, INVALID_ID

Fields inherited from interface de.xima.fc.entities.interfaces.IUUIDEntity

ATTR_UUID, INVALID_UUID, INVALID_UUID_OBJECT, NULL_SAFE_UUID_TYPE, NULLABLE_UUID_TYPE, TYPE_NAME_UUID

Constructor Summary

Constructors

Constructor	Description
Textbaustein()

Method Summary

Modifier and Type	Method	Description
String	getBeschreibung()
Map<String,String>	getCustomAttributes()	Gets the custom attributes that may be used to store additional information.
Map<String,String>	getI18nValues()
Long	getId()
ETextbausteinKategorie	getKategorie()
List<String>	getKeywords()
String	getKeywordsJoined()
ETextbausteinMsgCode	getMsgCode()
String	getName()
String	getTextValue()
String	getUUID()	Gets the UUID (universal unique identifier) that uniquely identifies this type of entity.
UUID	getUUIDObject()	Gets the UUID (universal unique identifier) that uniquely identifies this type of entity.
boolean	isAllowFormTheme()	Applies only to text templates of category HTML.
boolean	isDeletable()
boolean	isDeprecated()
boolean	isSystem()
void	setAllowFormTheme(boolean allowFormTheme)	Applies only to text templates of category HTML.
void	setBeschreibung(String beschreibung)
void	setCustomAttributes(Map<String,String> customAttributes)	Sets the custom attributes that may be used to store additional information.
void	setDeletable(boolean deletable)
void	setDeprecated(boolean deprecated)
void	setI18nValues(Map<String,String> i18nValues)
void	setId(Long id)	!!!WARNING: Currently values bigger Integer.MAX_VALUE or lower then Integer.MIN_VALUE will be altered to null!!!
void	setKategorie(ETextbausteinKategorie kategorie)
void	setKeywords(List<String> keywords)
void	setMsgCode(ETextbausteinMsgCode msgCode)
void	setName(String name)
void	setSystem(boolean system)
void	setTextValue(String textValue)
void	setUUID(String uuid)	Sets the UUID (universal unique identifier) that uniquely identifies this type of entity.
void	setUUIDObject(UUID uuid)

Methods inherited from class de.xima.fc.entities.AClientDependentEntity

getMandant, setMandant

Methods inherited from class de.xima.fc.entities.AbstractLockableEntity

entityHasChanged, getLockingVersion, setLockingVersion, toString

Methods inherited from class de.xima.fc.entities.AbstractEntity

asIntValue, isPersisted, setId

Methods inherited from class de.xima.cmn.dao.model.AEntity

compareTo, equals, getDBTableName, hashCode

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface de.xima.fc.entities.interfaces.ICustomAttributeProviding

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

Methods inherited from interface de.xima.fc.entities.interfaces.ICustomAttributesEntity

removeCustomAttribute, setCustomAttribute, setCustomAttributeBoolean, setCustomAttributeDouble, setCustomAttributeEnum, setCustomAttributeInt, setCustomAttributeJSONArray, setCustomAttributeJSONObject, setCustomAttributeLong, setCustomAttributeString, setCustomAttributeUuid

Methods inherited from interface de.xima.fc.entities.interfaces.IDescriptionProviding

getDescription

Methods inherited from interface de.xima.cmn.dao.interfaces.IEntity

isPersisted

Field Detail

ATTR_MSGCODE

public static final String ATTR_MSGCODE

JPA attribute name for the getMsgCode() field.

See Also:

Constant Field Values

ATTR_KATEGORIE

public static final String ATTR_KATEGORIE

JPA attribute name for the getKategorie() field.

See Also:

Constant Field Values

ATTR_SYSTEM

public static final String ATTR_SYSTEM

JPA attribute name for the isSystem() field.

See Also:

Constant Field Values

ATTR_DELETABLE

public static final String ATTR_DELETABLE

JPA attribute name for the isDeletable() field.

See Also:

Constant Field Values

ATTR_DEPRECATED

public static final String ATTR_DEPRECATED

JPA attribute name for the isDeprecated() field.

See Also:

Constant Field Values

ATTR_TEXT_VALUE

public static final String ATTR_TEXT_VALUE

JPA attribute name for the getTextValue() field.

See Also:

Constant Field Values

ATTR_KEYWORDS

public static final String ATTR_KEYWORDS

JPA attribute name for the getKeywords() field.

See Also:

Constant Field Values

ATTR_CUSTOM_ATTRIBUTES

public static final String ATTR_CUSTOM_ATTRIBUTES

JPA attribute name for the getCustomAttributes() field.

Since:

8.3.0

See Also:

Constant Field Values

COL_UUID

public static final String COL_UUID

Database column name for the getUUIDObject() field.

See Also:

Constant Field Values

Constructor Detail

Textbaustein

public Textbaustein()

Method Detail

getId

public Long getId()

Specified by:

getId in interface de.xima.cmn.dao.interfaces.IEntity<Long>

getCustomAttributes

public Map<String,String> getCustomAttributes()

Gets the custom attributes that may be used to store additional information. The stored data depends on the type of the text template.

Specified by:

getCustomAttributes in interface ICustomAttributeProviding

Returns:

The custom attributes.

Since:

8.3.0

isAllowFormTheme

public boolean isAllowFormTheme()

Applies only to text templates of category HTML. Whether this text template allows a form theme to be applied. When true, the form theme of the current form is applied to the text template. If no form context is available, the default client or system form theme is used instead.

Returns:

Whether this text template allows a form theme to be applied.

setAllowFormTheme

public void setAllowFormTheme(boolean allowFormTheme)

Applies only to text templates of category HTML. Whether this text template allows a form theme to be applied. When true, the form theme of the current form is applied to the text template. If no form context is available, the default client or system form theme is used instead.

Parameters:

allowFormTheme - Whether this text template allows a form theme to be applied.

setCustomAttributes

public void setCustomAttributes(Map<String,String> customAttributes)

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

Specified by:

setCustomAttributes in interface ICustomAttributesEntity

Parameters:

customAttributes - The custom attributes to set.

Since:

8.3.0

getUUID

public String getUUID()

Description copied from interface: IUUIDEntity

Gets the UUID (universal unique identifier) that uniquely identifies this type of entity. Whether the UUID must be globally unique or only with within a context depends on the type of entity. Common contexts are for example client scopes or project scope.

Specified by:

getUUID in interface IUUIDEntity

Returns:

The UUID of the entity.

setUUID

public void setUUID(String uuid)

Description copied from interface: IUUIDEntity

Sets the UUID (universal unique identifier) that uniquely identifies this type of entity. Whether the UUID must be globally unique or only with within a context depends on the type of entity. Common contexts are for example client scopes or project scope.

Specified by:

setUUID in interface IUUIDEntity

Parameters:

uuid - The UUID of the entity.

getUUIDObject

public UUID getUUIDObject()

Description copied from interface: IUUIDEntity

Gets the UUID (universal unique identifier) that uniquely identifies this type of entity. Whether the UUID must be globally unique or only with within a context depends on the type of entity. Common contexts are for example client scopes or project scope.

Specified by:

getUUIDObject in interface IUUIDEntity

Returns:

The UUID of the entity.

setUUIDObject

public void setUUIDObject(UUID uuid)

setId

public void setId(Long id)

Description copied from class: AbstractEntity

!!!WARNING: Currently values bigger Integer.MAX_VALUE or lower then Integer.MIN_VALUE will be altered to null!!!

Specified by:

setId in interface de.xima.cmn.dao.interfaces.IEntity<Long>

Overrides:

setId in class AbstractEntity

Parameters:

id - Long the database-id to set

getName

public String getName()

Specified by:

getName in interface INameProviding

Returns:

The name of this object.

setName

public void setName(String name)

getTextValue

public String getTextValue()

setTextValue

public void setTextValue(String textValue)

getKategorie

public ETextbausteinKategorie getKategorie()

setKategorie

public void setKategorie(ETextbausteinKategorie kategorie)

isDeletable

public boolean isDeletable()

setDeletable

public void setDeletable(boolean deletable)

getMsgCode

public ETextbausteinMsgCode getMsgCode()

setMsgCode

public void setMsgCode(ETextbausteinMsgCode msgCode)

isSystem

public boolean isSystem()

setSystem

public void setSystem(boolean system)

isDeprecated

public boolean isDeprecated()

setDeprecated

public void setDeprecated(boolean deprecated)

getBeschreibung

public String getBeschreibung()

Specified by:

getBeschreibung in interface IDescriptionProviding

setBeschreibung

public void setBeschreibung(String beschreibung)

getI18nValues

public Map<String,String> getI18nValues()

setI18nValues

public void setI18nValues(Map<String,String> i18nValues)

getKeywords

public List<String> getKeywords()

Returns:

list of keywords assigned to this template (requires the associated template type to support keywords)

See Also:

ETextbausteinKategorie.isSupportsKeywords()

setKeywords

public void setKeywords(List<String> keywords)

Parameters:

keywords - list of keywords to be assigned to this template (requires the associated template type to support keywords)

See Also:

ETextbausteinKategorie.isSupportsKeywords()

getKeywordsJoined

public String getKeywordsJoined()

Returns:

a string with all of the keywords of this template or null, if this template has no keywords