Class ProjectPortalTag

java.lang.Object
de.xima.cmn.dao.model.AEntity<Long>
de.xima.fc.entities.AbstractEntity
de.xima.fc.entities.AbstractLockableEntity
de.xima.fc.entities.ProjectPortalTag
All Implemented Interfaces:
de.xima.cmn.dao.interfaces.IEntity<Long>, de.xima.cmn.dao.interfaces.ILockableEntity<Long>, ILocalizationProviding<ProjectPortalTag, ProjectPortalTagLocalization>, ILockingVersionProviding, ITransferable, ITransferableEntity, ITransferableLockableEntity, IUUIDEntity, Serializable, Comparable<de.xima.cmn.dao.interfaces.IEntity<Long>>
@Entity public class ProjectPortalTag extends AbstractLockableEntity implements IUUIDEntity, ILocalizationProviding<ProjectPortalTag, ProjectPortalTagLocalization>
Entity model for end user tags. user portals tags are manged portal-wide and may be assigned to forms.
Since:
8.2.0
Author:
XIMA MEDIA GmbH
See Also:

  • Field Details

  • Constructor Details

    • ProjectPortalTag

      public ProjectPortalTag()

  • Method Details

    • 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)

    • getColorBackground

      public RgbaQuadruplet getColorBackground()
      Gets the background color of this tag, used when the tag is displayed in the UI.
      Returns:
      The color of this tag.

    • setColorBackground

      public void setColorBackground(RgbaQuadruplet colorBackground)
      Sets the background color of this tag, used when the tag is displayed in the UI.
      Parameters:
      colorBackground - The color of this tag.

    • getColorText

      public RgbaQuadruplet getColorText()
      Gets the text color of this tag, used when the tag is displayed in the UI.
      Returns:
      The text color of this tag.

    • setColorText

      public void setColorText(RgbaQuadruplet colorText)
      Sets the text color of this tag, used when the tag is displayed in the UI.
      Parameters:
      colorText - The text color of this tag.

    • getDefaultLocale

      public Locale getDefaultLocale()

    • setDefaultLocale

      public void setDefaultLocale(Locale defaultLocale)

    • getId

      public Long getId()
      The unique database ID of this tag. Used internally, should not be made available to users.
      Specified by:
      getId in interface de.xima.cmn.dao.interfaces.IEntity<Long>
      Returns:
      The unique database ID of this tag.

    • getLocalizations

      public List<ProjectPortalTagLocalization> getLocalizations()
      Gets all localization associated with this tag. A tag may contain a localized message for each message key and locale. There are some pre-defined message keys that are used by the system, such as the display name of the tag, but custom message keys may be used as well.
      Specified by:
      getLocalizations in interface ILocalizationProviding<ProjectPortalTag, ProjectPortalTagLocalization>
      Returns:
      All localization associated with this tag.

    • setLocalizations

      public void setLocalizations(List<ProjectPortalTagLocalization> localizations)
      Gets all localization associated with this tag. A tag may contain a localized message for each message key and locale. There are some pre-defined message keys that are used by the system, such as the display name of the tag, but custom message keys may be used as well.
      Parameters:
      localizations - All localization associated with this tag.

    • getLocalizationsDefaultLocale

      public Locale getLocalizationsDefaultLocale()
      Description copied from interface: ILocalizationProviding
      Gets the default locale for this providing object.
      Specified by:
      getLocalizationsDefaultLocale in interface ILocalizationProviding<ProjectPortalTag, ProjectPortalTagLocalization>
      Returns:
      the default locale for this providing object

    • getProjectConfigs

      @NotEmpty public @NotEmpty Set<ProjectPortalConfig> getProjectConfigs()
      Gets the portalConfigs this tag is associated with.
      Returns:
      The portalConfigs this tag is associated with.

    • setProjectConfigs

      public void setProjectConfigs(@NotEmpty @NotEmpty Set<ProjectPortalConfig> projectConfigs)
      Sets the projects this tag is associated with.
      Parameters:
      projectConfigs - The projects this tag is associated with.

    • getDescription

      public String getDescription(Locale locale)
      Gets the description of this tag in the given locale. Falls back to the default locale when no localization is available for the given locale.
      Parameters:
      locale - The locale to get the description for.
      Returns:
      The description of this tag in the given locale.

    • getDisplayName

      public String getDisplayName(Locale locale)
      Gets the display name of this tag in the given locale. Falls back to the default locale when no localization is available for the given locale.
      Parameters:
      locale - The locale to get the display name for.
      Returns:
      The display name of this tag in the given locale.

    • newLocalization

      public ProjectPortalTagLocalization newLocalization()
      Description copied from interface: ILocalizationProviding
      Creates a new localization object.
      Specified by:
      newLocalization in interface ILocalizationProviding<ProjectPortalTag, ProjectPortalTagLocalization>
      Returns:
      a new localization object