Package de.xima.fc.entities

Class UserPortalState

java.lang.Object

de.xima.cmn.dao.model.AEntity<Long>

de.xima.fc.entities.AbstractEntity

de.xima.fc.entities.AbstractLockableEntity

de.xima.fc.entities.UserPortalState

All Implemented Interfaces:

de.xima.cmn.dao.interfaces.IEntity<Long>, de.xima.cmn.dao.interfaces.ILockableEntity<Long>, ILocalizationProviding<UserPortalState,UserPortalStateLocalization>, ILockingVersionProviding, ITransferable, ITransferableEntity, ITransferableLockableEntity, Serializable, Comparable<de.xima.cmn.dao.interfaces.IEntity<Long>>

@Entity
public class UserPortalState
extends AbstractLockableEntity
implements ILocalizationProviding<UserPortalState,UserPortalStateLocalization>

Entity model for user portal states.

Since:

8.2.0

Author:

XIMA MEDIA GmbH

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static String	ATTR_COLOR_BACKGROUND	Database column name for the getColorBackground() field.
static String	ATTR_COLOR_TEXT	Database column name for the getColorText() field.
static String	ATTR_ICON_STYLE_CLASS	Database column name for the getIconStyleClass() field.
static String	ATTR_RECORD_ACCESSIBLE	Database column name for the isRecordAccessible() field.
static String	ATTR_TYPE	Database column name for the getType() field.
static String	ATTR_WORKFLOW_STATE	Database column name for the getWorkflowState() field.
static String	COL_COLOR_BACKGROUND	Database column name for the getColorBackground() field.
static String	COL_COLOR_TEXT	Database column name for the getColorText() field.
static String	COL_ICON_STYLE_CLASS	Database column name for the getIconStyleClass() field.
static String	COL_RECORD_ACCESSIBLE	Database column name for the isRecordAccessible() field.
static String	COL_TYPE	Database column name for the getType() field.
static String	COL_WORKFLOW_STATE_ID	Database column name for the getWorkflowState() field.

Fields inherited from class de.xima.fc.entities.AbstractLockableEntity

COL_LOCKINGVERSION, lockingVersion

Fields inherited from class de.xima.fc.entities.AbstractEntity

COL_ID, id

Fields inherited from interface de.xima.cmn.dao.interfaces.IEntity

ATTR_ID

Fields inherited from interface de.xima.fc.entities.interfaces.i18n.ILocalizationProviding

ATTR_LOCALIZATIONS

Fields inherited from interface de.xima.cmn.dao.interfaces.ILockableEntity

ATTR_LOCKINGVERSION

Fields inherited from interface de.xima.fc.entities.interfaces.ITransferableEntity

IMPORT_ID, INVALID_ID

Constructor Summary

Constructors

Constructor	Description
UserPortalState()

Method Summary

Modifier and Type	Method	Description
UserPortalState	cloneBasics()
RgbaQuadruplet	getColorBackground()	Gets the color for the background when displaying the name of this state (e.g.
RgbaQuadruplet	getColorText()	Gets the color for the text when displaying the name of this state (e.g.
Locale	getFallbackLocale()	Gets the default locale to use as a fallback when a localization is missing for a locale.
String	getIconStyleClass()
Long	getId()
List<UserPortalStateLocalization>	getLocalizations()	Gets the localisation entities
EUserPortalStateType	getType()
WorkflowState	getWorkflowState()
boolean	isRecordAccessible()
void	setColorBackground(RgbaQuadruplet colorBackground)	Sets the color for the background when displaying the name of this state (e.g.
void	setColorText(RgbaQuadruplet colorText)	Sets the color for the text when displaying the name of this state (e.g.
void	setIconStyleClass(String iconStyleClass)
void	setLocalizations(List<UserPortalStateLocalization> localizations)	Sets the i18n name
void	setRecordAccessible(boolean recordAccessible)
void	setType(EUserPortalStateType type)
void	setWorkflowState(WorkflowState workflowState)

Methods inherited from class de.xima.fc.entities.AbstractLockableEntity

entityHasChanged, getLockingVersion, setLockingVersion, toString

Methods inherited from class de.xima.fc.entities.AbstractEntity

asIntValue, isPersisted, setId, setId

Methods inherited from class de.xima.cmn.dao.model.AEntity

compareTo, equals, getDBTableName, hashCode

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface de.xima.cmn.dao.interfaces.IEntity

isPersisted, setId

Methods inherited from interface de.xima.fc.entities.interfaces.i18n.ILocalizationProviding

getI18nNames, getLocalization, getLocalization, getLocalizationObject, getLocalizationObject, getLocalizationsByI18nName, getLocalizationsByI18nName, getLocalizationsByI18nName, getLocalizationsByI18nName, getLocalizationsByLocale, getLocalizationsByLocale, getLocalizationsForLocale, getLocalizationsForLocale

Field Detail

ATTR_WORKFLOW_STATE

public static final String ATTR_WORKFLOW_STATE

Database column name for the getWorkflowState() field.

See Also:

Constant Field Values

ATTR_TYPE

public static final String ATTR_TYPE

Database column name for the getType() field.

See Also:

Constant Field Values

ATTR_RECORD_ACCESSIBLE

public static final String ATTR_RECORD_ACCESSIBLE

Database column name for the isRecordAccessible() field.

See Also:

Constant Field Values

ATTR_ICON_STYLE_CLASS

public static final String ATTR_ICON_STYLE_CLASS

Database column name for the getIconStyleClass() field.

See Also:

Constant Field Values

ATTR_COLOR_TEXT

public static final String ATTR_COLOR_TEXT

Database column name for the getColorText() field.

See Also:

Constant Field Values

ATTR_COLOR_BACKGROUND

public static final String ATTR_COLOR_BACKGROUND

Database column name for the getColorBackground() field.

See Also:

Constant Field Values

COL_WORKFLOW_STATE_ID

public static final String COL_WORKFLOW_STATE_ID

Database column name for the getWorkflowState() field.

See Also:

Constant Field Values

COL_TYPE

public static final String COL_TYPE

Database column name for the getType() field.

See Also:

Constant Field Values

COL_RECORD_ACCESSIBLE

public static final String COL_RECORD_ACCESSIBLE

Database column name for the isRecordAccessible() field.

See Also:

Constant Field Values

COL_ICON_STYLE_CLASS

public static final String COL_ICON_STYLE_CLASS

Database column name for the getIconStyleClass() field.

See Also:

Constant Field Values

COL_COLOR_TEXT

public static final String COL_COLOR_TEXT

Database column name for the getColorText() field.

See Also:

Constant Field Values

COL_COLOR_BACKGROUND

public static final String COL_COLOR_BACKGROUND

Database column name for the getColorBackground() field.

See Also:

Constant Field Values

Constructor Detail

UserPortalState

public UserPortalState()

Method Detail

getId

public Long getId()

Specified by:

getId in interface de.xima.cmn.dao.interfaces.IEntity<Long>

getWorkflowState

public WorkflowState getWorkflowState()

setWorkflowState

public void setWorkflowState(WorkflowState workflowState)

getType

public EUserPortalStateType getType()

setType

public void setType(EUserPortalStateType type)

isRecordAccessible

public boolean isRecordAccessible()

setRecordAccessible

public void setRecordAccessible(boolean recordAccessible)

getIconStyleClass

public String getIconStyleClass()

setIconStyleClass

public void setIconStyleClass(String iconStyleClass)

getColorText

public RgbaQuadruplet getColorText()

Gets the color for the text when displaying the name of this state (e.g. as a tag).

Returns:

The color for the text.

setColorText

public void setColorText(RgbaQuadruplet colorText)

Sets the color for the text when displaying the name of this state (e.g. as a tag).

Parameters:

colorText - The color for the text.

getColorBackground

public RgbaQuadruplet getColorBackground()

Gets the color for the background when displaying the name of this state (e.g. as a tag).

Returns:

The color for the background.

setColorBackground

public void setColorBackground(RgbaQuadruplet colorBackground)

Sets the color for the background when displaying the name of this state (e.g. as a tag).

Parameters:

colorBackground - The color for the background.

getLocalizations

public List<UserPortalStateLocalization> getLocalizations()

Description copied from interface: ILocalizationProviding

Gets the localisation entities

Specified by:

getLocalizations in interface ILocalizationProviding<UserPortalState,UserPortalStateLocalization>

Returns:

the localisation entities

setLocalizations

public void setLocalizations(List<UserPortalStateLocalization> localizations)

Description copied from interface: ILocalizationProviding

Sets the i18n name

Specified by:

setLocalizations in interface ILocalizationProviding<UserPortalState,UserPortalStateLocalization>

Parameters:

localizations - the entities for localisation to set

getFallbackLocale

public Locale getFallbackLocale()

Description copied from interface: ILocalizationProviding

Gets the default locale to use as a fallback when a localization is missing for a locale. May return null if the object does not provide a fallback locale.

Specified by:

getFallbackLocale in interface ILocalizationProviding<UserPortalState,UserPortalStateLocalization>

Returns:

the default locale to use as a fallback when a localization is missing for a locale

cloneBasics

public UserPortalState cloneBasics()