Class 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>>

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 Details

  • Constructor Details

    • Textbaustein

      public Textbaustein()
  • Method Details

    • 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:
    • 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:
    • getKeywordsJoined

      public String getKeywordsJoined()
      Returns:
      a string with all of the keywords of this template or null, if this template has no keywords