Class EndUserStateConfigViewModel

java.lang.Object
de.xima.fc.common.bean_models.workflow.state.EndUserStateConfigViewModel
All Implemented Interfaces:
Serializable
public final class EndUserStateConfigViewModel extends Object implements Serializable
View model for the workflow designer, for the end user state configuration of a workflow state
Since:
8.2.0
Author:
XIMA MEDIA GmbH
See Also:

  • Constructor Details

    • EndUserStateConfigViewModel

      public EndUserStateConfigViewModel()

  • Method Details

    • getBackgroundColor

      public String getBackgroundColor()
      Gets the background color for this end user state, used e.g. when displaying the state in the end user portal frontend. Must be a valid CSS color string.
      Returns:
      The background color.

    • setBackgroundColor

      public void setBackgroundColor(String backgroundColor)
      Sets the background color for this end user state, used e.g. when displaying the state in the end user portal frontend. Must be a valid CSS color string.
      Parameters:
      backgroundColor - The background color.

    • getIconStyleClass

      public String getIconStyleClass()
      Gets the CSS style class for the icon of this end user state. Can be any arbitrary CSS class (or classes). The UI offers a pre-defined set of CSS classes for the user to choose from, but also allows custom classes to be entered.
      Returns:
      The CSS style class(es).

    • setIconStyleClass

      public void setIconStyleClass(String iconStyleClass)
      Sets the CSS style class for the icon of this end user state. Can be any arbitrary CSS class (or classes). The UI offers a pre-defined set of CSS classes for the user to choose from, but also allows custom classes to be entered.
      Parameters:
      iconStyleClass - The CSS style class(es).

    • getLocalizations

      public EndUserStateLocalizationViewModel getLocalizations()
      Gets the view model with the localized messages.
      Returns:
      The localized messages.

    • setLocalizations

      public void setLocalizations(EndUserStateLocalizationViewModel localizations)
      Sets the model with the localized messages.
      Parameters:
      localizations - The map with the localized messages.

    • getTextColor

      public String getTextColor()
      Gets the text color for this end user state, used e.g. when displaying the state in the end user portal frontend. Must be a valid CSS color string.
      Returns:
      The text color.

    • setTextColor

      public void setTextColor(String textColor)
      Sets the text color for this end user state, used e.g. when displaying the state in the end user portal frontend. Must be a valid CSS color string.
      Parameters:
      textColor - The text color.

    • isEnabled

      public boolean isEnabled()
      Gets whether this end user state is enabled. When false, the state is not shown in the end user portal frontend.
      Returns:
      True if the state is enabled, false otherwise.

    • setEnabled

      public void setEnabled(boolean enabled)
      Sets whether this end user state is enabled. When false, the state is not shown in the end user portal frontend.
      Parameters:
      enabled - True if the state is enabled, false otherwise.

    • isTerminalState

      public boolean isTerminalState()
      Whether this end user state represents a terminal state. When a state is marked as terminal, the form record is shown as completed in the end user portal frontend.
      Returns:
      True if the state is terminal, false otherwise.

    • setTerminalState

      public void setTerminalState(boolean terminalState)
      Set whether this end user state represents a terminal state. When a state is marked as terminal, the form record is shown as completed in the end user portal frontend.
      Parameters:
      terminalState - True if the state is terminal, false otherwise.