Package de.xima.fc.dao.form_record.dto

Class EndUserStateDTO

java.lang.Object

de.xima.fc.dao.form_record.dto.EndUserStateDTO

All Implemented Interfaces:

Serializable

public class EndUserStateDTO
extends Object
implements Serializable

DTO for form record states.

This DTO is used to provide information about the state of a form record to the end user. It contains the display name, description, icon style class and colors of the state.

Since:

8.4.0

Author:

XIMA MEDIA GmbH

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	EndUserStateDTO.Type

Constructor Summary

Constructors

Constructor	Description
EndUserStateDTO(WorkflowState state, Locale locale)	Constructor.

Method Summary

Modifier and Type	Method	Description
static EndUserStateDTO	getDefault(Locale locale, Locale fallbackLocale)	Gets the default end user state DTO.
String	getDescription()
String	getDisplayName()
String	getHexColorBackground()
String	getHexColorText()
String	getIconStyleClass()
static EndUserStateDTO	getSaved(Locale locale, Locale fallbackLocale)	Gets the end user state DTO for a saved state.
EndUserStateDTO.Type	getType()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

EndUserStateDTO

public EndUserStateDTO(WorkflowState state,
                       Locale locale)

Constructor.

Parameters:

state - The state.

locale - The locale.

Method Detail

getDefault

public static EndUserStateDTO getDefault(Locale locale,
                                         Locale fallbackLocale)

Gets the default end user state DTO. This should be used when no state is available. The default state is "In Progress".

Parameters:

locale - The locale to create the default state for.

fallbackLocale - The fallback locale to use if the locale is not available.

Returns:

The default end user state DTO.

getSaved

public static EndUserStateDTO getSaved(Locale locale,
                                       Locale fallbackLocale)

Gets the end user state DTO for a saved state. This should be used when a form record is saved.

Parameters:

locale - The locale to create the saved state for.

fallbackLocale - The fallback locale to use if the locale is not available.

Returns:

The end user state DTO for a saved state.

getDescription

public String getDescription()

getDisplayName

public String getDisplayName()

getHexColorBackground

public String getHexColorBackground()

getHexColorText

public String getHexColorText()

getIconStyleClass

public String getIconStyleClass()

getType

public EndUserStateDTO.Type getType()