Package de.xima.fc.entities

Class UserPortal

java.lang.Object

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

de.xima.fc.entities.AbstractEntity

de.xima.fc.entities.AbstractLockableEntity

de.xima.fc.entities.UserPortal

All Implemented Interfaces:

de.xima.cmn.dao.interfaces.IEntity<Long>, de.xima.cmn.dao.interfaces.ILockableEntity<Long>, ILocalizedScopedFilesProviding<UserPortal,UserPortalFile,UserPortalFileData>, ILocalizationProviding<UserPortal,UserPortalLocalization>, IDescriptionProviding, ILockingVersionProviding, INameProviding, ITransferable, ITransferableEntity, ITransferableLockableEntity, IUUIDEntity, Serializable, Comparable<de.xima.cmn.dao.interfaces.IEntity<Long>>

@Entity
public class UserPortal
extends AbstractLockableEntity
implements INameProviding, IDescriptionProviding, IUUIDEntity, ILocalizationProviding<UserPortal,UserPortalLocalization>, ILocalizedScopedFilesProviding<UserPortal,UserPortalFile,UserPortalFileData>

Entity model for user portals.

Since:

8.2.0

Author:

XIMA MEDIA GmbH

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static String	ATTR_ACTIVE
static String	ATTR_ACTIVE_ON_MASTER_SERVER
static String	ATTR_ALIAS
static String	ATTR_AUTHENTICATOR_CONFIGS
static String	ATTR_CLIENT_PORTAL_CONFIGS
static String	ATTR_DEFAULT_LOCALE
static String	ATTR_FRONTEND_SERVERS
static String	ATTR_LOGIN_CONFIG
static String	ATTR_TAGS
static String	ATTR_USER_PROFILES
static String	COL_ALIAS
static String	COL_DEFAULT_LOCALE
static String	COL_FLAG_ACTIVE
static String	COL_FLAG_ACTIVE_ON_MS

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.fc.entities.interfaces.IDescriptionProviding

ATTR_BESCHREIBUNG, ATTR_DESCRIPTION, COL_DESCRIPTION

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.fc.entities.interfaces.file.i18n.ILocalizedScopedFilesProviding

ATTR_FILES

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

ATTR_LOCKINGVERSION

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

ATTR_NAME, COL_NAME

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

IMPORT_ID, INVALID_ID

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

ATTR_UUID, COL_UUID, INVALID_UUID, INVALID_UUID_OBJECT, NULL_SAFE_UUID_TYPE, NULLABLE_UUID_TYPE, TYPE_NAME_UUID

Constructor Summary

Constructors

Constructor	Description
UserPortal()

Method Summary

Modifier and Type	Method	Description
ClientPortalConfig	addClientConfig(Mandant client)
void	addFrontendServer(FrontendServer entity)
void	addFrontendServer(MandantFrontendServer entity)
String	getAlias()
String	getBeschreibung()	Deprecated. Use getDescription() instead.
ClientPortalConfig	getClientPortalConfig(long clientId)	Returns the client portal configuration for the given client.
ClientPortalConfig	getClientPortalConfig(Mandant client)	Returns the client portal configuration for the given client.
Set<ClientPortalConfig>	getClientPortalConfigs()
Locale	getDefaultLocale()
String	getDescription()
Locale	getFallbackLocale()	Gets the default locale to use as a fallback when a localization is missing for a locale.
List<UserPortalFile>	getFiles()	Gets the file entities.
Set<FrontendServer>	getFrontendServers()
Long	getId()
List<UserPortalLocalization>	getLocalizations()	Gets the localisation entities
UserPortalLoginConfig	getLoginConfig()
String	getName()
ProjectPortalConfig	getProjectPortalConfig(Projekt project)	Returns the project portal configuration for the given project.
UserPortalProperties	getProperties()
Set<UserPortalTag>	getTags()	Gets the tags of this portal.
Set<UserProfile>	getUserProfiles()
String	getUUID()	Gets the UUID (universal unique identifier) that uniquely identifies this type of entity.
UUID	getUUIDObject()	Gets the UUID (universal unique identifier) that uniquely identifies this type of entity.
boolean	isActive()
boolean	isActiveOnMasterServer()
void	prePersist()
void	setActive(boolean active)
void	setActiveOnMasterServer(boolean activeOnMasterServer)
void	setAlias(String alias)
void	setClientPortalConfigs(Set<ClientPortalConfig> clientPortalConfigs)
void	setDefaultLocale(Locale defaultLocale)
void	setDescription(String description)
void	setFiles(List<UserPortalFile> files)	Sets the file entities.
void	setFrontendServers(Set<FrontendServer> frontendServers)
void	setId(Long id)	!!!WARNING: Currently values bigger Integer.MAX_VALUE or lower then Integer.MIN_VALUE will be altered to null!!!
void	setLocalizations(List<UserPortalLocalization> localizations)	Sets the i18n name
void	setLoginConfig(UserPortalLoginConfig loginConfig)
void	setName(String name)
void	setProperties(UserPortalProperties properties)
void	setTags(Set<UserPortalTag> tags)	Sets the tags of this portal.
void	setUserProfiles(Set<UserProfile> userProfiles)
void	setUUID(String uuid)	Sets the UUID (universal unique identifier) that uniquely identifies this type of entity.
void	setUUIDObject(UUID uuid)

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

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

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

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

Methods inherited from interface de.xima.fc.entities.interfaces.file.i18n.ILocalizedScopedFilesProviding

addFile, getFile, getFile, getFileKeys, getFileMapByKey, getFileMapByKey, getFileMapByLocale, getFileMapByLocale, getFiles, getFiles, removeFile

Field Detail

ATTR_ALIAS

public static final String ATTR_ALIAS

See Also:

Constant Field Values

ATTR_ACTIVE

public static final String ATTR_ACTIVE

See Also:

Constant Field Values

ATTR_ACTIVE_ON_MASTER_SERVER

public static final String ATTR_ACTIVE_ON_MASTER_SERVER

See Also:

Constant Field Values

ATTR_DEFAULT_LOCALE

public static final String ATTR_DEFAULT_LOCALE

See Also:

Constant Field Values

ATTR_LOGIN_CONFIG

public static final String ATTR_LOGIN_CONFIG

See Also:

Constant Field Values

ATTR_FRONTEND_SERVERS

public static final String ATTR_FRONTEND_SERVERS

See Also:

Constant Field Values

ATTR_CLIENT_PORTAL_CONFIGS

public static final String ATTR_CLIENT_PORTAL_CONFIGS

See Also:

Constant Field Values

ATTR_AUTHENTICATOR_CONFIGS

public static final String ATTR_AUTHENTICATOR_CONFIGS

See Also:

Constant Field Values

ATTR_TAGS

public static final String ATTR_TAGS

See Also:

Constant Field Values

ATTR_USER_PROFILES

public static final String ATTR_USER_PROFILES

See Also:

Constant Field Values

COL_FLAG_ACTIVE

public static final String COL_FLAG_ACTIVE

See Also:

Constant Field Values

COL_FLAG_ACTIVE_ON_MS

public static final String COL_FLAG_ACTIVE_ON_MS

See Also:

Constant Field Values

COL_DEFAULT_LOCALE

public static final String COL_DEFAULT_LOCALE

See Also:

Constant Field Values

COL_ALIAS

public static final String COL_ALIAS

See Also:

Constant Field Values

Constructor Detail

UserPortal

public UserPortal()

Method Detail

getId

public Long getId()

Specified by:

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

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

getProperties

public UserPortalProperties getProperties()

setProperties

public void setProperties(UserPortalProperties properties)

getAlias

public String getAlias()

setAlias

public void setAlias(String alias)

isActive

public boolean isActive()

setActive

public void setActive(boolean active)

isActiveOnMasterServer

public boolean isActiveOnMasterServer()

setActiveOnMasterServer

public void setActiveOnMasterServer(boolean activeOnMasterServer)

getDefaultLocale

public Locale getDefaultLocale()

setDefaultLocale

public void setDefaultLocale(Locale defaultLocale)

getLoginConfig

public UserPortalLoginConfig getLoginConfig()

setLoginConfig

public void setLoginConfig(UserPortalLoginConfig loginConfig)

getName

public String getName()

Specified by:

getName in interface INameProviding

Returns:

The name of this object.

setName

public void setName(String name)

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)

getFiles

public List<UserPortalFile> getFiles()

Description copied from interface: ILocalizedScopedFilesProviding

Gets the file entities.

Specified by:

getFiles in interface ILocalizedScopedFilesProviding<UserPortal,UserPortalFile,UserPortalFileData>

Returns:

the file entities

setFiles

public void setFiles(List<UserPortalFile> files)

Description copied from interface: ILocalizedScopedFilesProviding

Sets the file entities.

Specified by:

setFiles in interface ILocalizedScopedFilesProviding<UserPortal,UserPortalFile,UserPortalFileData>

Parameters:

files - the file entities to set.

getLocalizations

public List<UserPortalLocalization> getLocalizations()

Description copied from interface: ILocalizationProviding

Gets the localisation entities

Specified by:

getLocalizations in interface ILocalizationProviding<UserPortal,UserPortalLocalization>

Returns:

the localisation entities

setLocalizations

public void setLocalizations(List<UserPortalLocalization> localizations)

Description copied from interface: ILocalizationProviding

Sets the i18n name

Specified by:

setLocalizations in interface ILocalizationProviding<UserPortal,UserPortalLocalization>

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<UserPortal,UserPortalLocalization>

Specified by:

getFallbackLocale in interface ILocalizedScopedFilesProviding<UserPortal,UserPortalFile,UserPortalFileData>

Returns:

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

getFrontendServers

public Set<FrontendServer> getFrontendServers()

setFrontendServers

public void setFrontendServers(Set<FrontendServer> frontendServers)

getClientPortalConfigs

public Set<ClientPortalConfig> getClientPortalConfigs()

setClientPortalConfigs

public void setClientPortalConfigs(Set<ClientPortalConfig> clientPortalConfigs)

getTags

public Set<UserPortalTag> getTags()

Gets the tags of this portal. Each tag belongs to exactly one portal, but a portal may have many tags. A portal's tags should be considered a tag pool. Each form may have multiple tags assigned to it, taken from this tag pool.

Returns:

The tags of this portal.

setTags

public void setTags(Set<UserPortalTag> tags)

Sets the tags of this portal. Each tag belongs to exactly one portal, but a portal may have many tags. A portal's tags should be considered a tag pool. Each form may have multiple tags assigned to it, taken from this tag pool.

Parameters:

tags - The tags of this portal.

getUserProfiles

public Set<UserProfile> getUserProfiles()

setUserProfiles

public void setUserProfiles(Set<UserProfile> userProfiles)

getBeschreibung

@Deprecated
public String getBeschreibung()

Deprecated.

Use getDescription() instead.

Specified by:

getBeschreibung in interface IDescriptionProviding

See Also:

getDescription()

getDescription

public String getDescription()

Specified by:

getDescription in interface IDescriptionProviding

Returns:

A human-readable description for this object.

setDescription

public void setDescription(String description)

getClientPortalConfig

public ClientPortalConfig getClientPortalConfig(Mandant client)

Returns the client portal configuration for the given client.

Parameters:

client - Client for which to get the configuration.

Returns:

Configuration for the given client if it exists.

getClientPortalConfig

public ClientPortalConfig getClientPortalConfig(long clientId)

Returns the client portal configuration for the given client.

Parameters:

clientId - ID of the client for which to get the configuration.

Returns:

Configuration for the given client if it exists.

getProjectPortalConfig

public ProjectPortalConfig getProjectPortalConfig(Projekt project)

Returns the project portal configuration for the given project.

Parameters:

project - The project to get the config for.

Returns:

The project portal config for the given project if it exists.

addFrontendServer

public void addFrontendServer(MandantFrontendServer entity)

addFrontendServer

public void addFrontendServer(FrontendServer entity)

addClientConfig

public ClientPortalConfig addClientConfig(Mandant client)

prePersist

public void prePersist()