Class Textbaustein
java.lang.Object
de.xima.cmn.dao.model.AEntity<Long>
- 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:
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final StringJPA attribute name for thegetCustomAttributes()field.static final StringJPA attribute name for theisDeletable()field.static final StringJPA attribute name for theisDeprecated()field.static final StringJPA attribute name for thegetKategorie()field.static final StringJPA attribute name for thegetKeywords()field.static final StringJPA attribute name for thegetMsgCode()field.static final StringJPA attribute name for theisSystem()field.static final StringJPA attribute name for thegetTextValue()field.static final StringDatabase column name for thegetUUIDObject()field.Fields inherited from class AClientDependentEntity
COL_CLIENTID, mandantFields inherited from class AbstractLockableEntity
COL_LOCKINGVERSION, lockingVersionFields inherited from class AbstractEntity
COL_ID, idFields inherited from interface ICustomAttributesEntity
COL_CUSTOM_ATTRIBUTE_NAME, COL_CUSTOM_ATTRIBUTE_VALUEFields inherited from interface IDescriptionProviding
ATTR_BESCHREIBUNG, ATTR_DESCRIPTION, COL_DESCRIPTIONFields inherited from interface de.xima.cmn.dao.interfaces.IEntity
ATTR_IDFields inherited from interface de.xima.cmn.dao.interfaces.ILockableEntity
ATTR_LOCKINGVERSIONFields inherited from interface IMandantDependent
ATTR_CLIENT, ATTR_MANDANT, COL_CLIENT_IDFields inherited from interface INameProviding
ATTR_NAME, COL_NAMEFields inherited from interface ITransferableEntity
IMPORT_ID, INVALID_IDFields inherited from interface IUUIDEntity
ATTR_UUID, INVALID_UUID, INVALID_UUID_OBJECT, NULL_SAFE_UUID_TYPE, NULLABLE_UUID_TYPE, TYPE_NAME_UUID -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionGets the custom attributes that may be used to store additional information.getId()getName()getUUID()Gets the UUID (universal unique identifier) that uniquely identifies this type of entity.Gets the UUID (universal unique identifier) that uniquely identifies this type of entity.booleanbooleanbooleanbooleanisSystem()voidsetAllowFormTheme(boolean allowFormTheme) voidsetBeschreibung(String beschreibung) voidsetCustomAttributes(Map<String, String> customAttributes) Sets the custom attributes that may be used to store additional information.voidsetDeletable(boolean deletable) voidsetDeprecated(boolean deprecated) voidsetI18nValues(Map<String, String> i18nValues) void!!!voidsetKategorie(ETextbausteinKategorie kategorie) voidsetKeywords(List<String> keywords) voidsetMsgCode(ETextbausteinMsgCode msgCode) voidvoidsetSystem(boolean system) voidsetTextValue(String textValue) voidSets the UUID (universal unique identifier) that uniquely identifies this type of entity.voidsetUUIDObject(UUID uuid) Methods inherited from class AClientDependentEntity
getMandant, setMandantMethods inherited from class AbstractLockableEntity
entityHasChanged, getLockingVersion, setLockingVersion, toStringMethods inherited from class AbstractEntity
asIntValue, isPersisted, setIdMethods inherited from class de.xima.cmn.dao.model.AEntity
compareTo, equals, getDBTableName, hashCodeMethods inherited from interface Comparable
compareToMethods inherited from interface ICustomAttributeProviding
getCustomAttribute, getCustomAttributeAs, getCustomAttributeAs, getCustomAttributeBoolean, getCustomAttributeDouble, getCustomAttributeDouble, getCustomAttributeEnum, getCustomAttributeEnum, getCustomAttributeInt, getCustomAttributeInt, getCustomAttributeJsonArray, getCustomAttributeJsonObject, getCustomAttributeLong, getCustomAttributeLong, getCustomAttributeString, getCustomAttributeString, getCustomAttributeUuidMethods inherited from interface ICustomAttributesEntity
removeCustomAttribute, setCustomAttribute, setCustomAttributeBoolean, setCustomAttributeDouble, setCustomAttributeEnum, setCustomAttributeInt, setCustomAttributeJSONArray, setCustomAttributeJSONObject, setCustomAttributeLong, setCustomAttributeString, setCustomAttributeUuidMethods inherited from interface IDescriptionProviding
getDescriptionMethods inherited from interface de.xima.cmn.dao.interfaces.IEntity
isPersisted
-
Field Details
-
ATTR_MSGCODE
-
ATTR_KATEGORIE
JPA attribute name for thegetKategorie()field.- See Also:
-
ATTR_SYSTEM
-
ATTR_DELETABLE
-
ATTR_DEPRECATED
JPA attribute name for theisDeprecated()field.- See Also:
-
ATTR_TEXT_VALUE
JPA attribute name for thegetTextValue()field.- See Also:
-
ATTR_KEYWORDS
-
ATTR_CUSTOM_ATTRIBUTES
JPA attribute name for thegetCustomAttributes()field.- Since:
- 8.3.0
- See Also:
-
COL_UUID
-
-
Constructor Details
-
Textbaustein
public Textbaustein()
-
-
Method Details
-
getId
-
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:
getCustomAttributesin interfaceICustomAttributeProviding- Returns:
- The custom attributes.
- Since:
- 8.3.0
-
isAllowFormTheme
public boolean isAllowFormTheme()Applies only to text templates ofcategoryHTML. 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 ofcategoryHTML. 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
Sets the custom attributes that may be used to store additional information. The stored data depends on thetypeof the text template.- Specified by:
setCustomAttributesin interfaceICustomAttributesEntity- Parameters:
customAttributes- The custom attributes to set.- Since:
- 8.3.0
-
getUUID
Description copied from interface:IUUIDEntityGets 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 exampleclient scopesorproject scope.- Specified by:
getUUIDin interfaceIUUIDEntity- Returns:
- The UUID of the entity.
-
setUUID
Description copied from interface:IUUIDEntitySets 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 exampleclient scopesorproject scope.- Specified by:
setUUIDin interfaceIUUIDEntity- Parameters:
uuid- The UUID of the entity.
-
getUUIDObject
Description copied from interface:IUUIDEntityGets 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 exampleclient scopesorproject scope.- Specified by:
getUUIDObjectin interfaceIUUIDEntity- Returns:
- The UUID of the entity.
-
setUUIDObject
-
setId
Description copied from class:AbstractEntity!!!WARNING: Currently values biggerInteger.MAX_VALUEor lower thenInteger.MIN_VALUEwill be altered to null!!!- Specified by:
setIdin interfacede.xima.cmn.dao.interfaces.IEntity<Long>- Overrides:
setIdin classAbstractEntity- Parameters:
id-Longthe database-id to set
-
getName
- Specified by:
getNamein interfaceINameProviding- Returns:
- The name of this object.
-
setName
-
getTextValue
-
setTextValue
-
getKategorie
-
setKategorie
-
isDeletable
public boolean isDeletable() -
setDeletable
public void setDeletable(boolean deletable) -
getMsgCode
-
setMsgCode
-
isSystem
public boolean isSystem() -
setSystem
public void setSystem(boolean system) -
isDeprecated
public boolean isDeprecated() -
setDeprecated
public void setDeprecated(boolean deprecated) -
getBeschreibung
- Specified by:
getBeschreibungin interfaceIDescriptionProviding
-
setBeschreibung
-
getI18nValues
-
setI18nValues
-
getKeywords
-
setKeywords
-
getKeywordsJoined
- Returns:
- a string with all of the keywords of this template or
null, if this template has no keywords
-