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 final String	ATTR_ACTIVE
static final String	ATTR_ACTIVE_ON_MASTER_SERVER
static final String	ATTR_ALIAS
static final String	ATTR_AUTHENTICATOR_CONFIGS
static final String	ATTR_CLIENT_SCOPE
static final String	ATTR_DEFAULT_LOCALE
static final String	ATTR_FRONTEND_SERVERS
static final String	ATTR_LOGIN_CONFIG
static final String	ATTR_PROJECT_PORTAL_CONFIGS
static final String	ATTR_SHOW_ALL_FORM_RECORDS
static final String	ATTR_TAGS
static final String	ATTR_USER_PROFILES
static final String	COL_ALIAS
static final String	COL_CLIENT_SCOPE_ID
static final String	COL_DEFAULT_LOCALE
static final String	COL_FLAG_ACTIVE
static final String	COL_FLAG_ACTIVE_ON_MS
static final String	COL_FLAG_DISABLE_PUBLIC_FORMS
static final String	COL_FLAG_SHOW_ALL_FORM_RECORDS

Fields inherited from class AbstractLockableEntity

COL_LOCKINGVERSION, lockingVersion

Fields inherited from class AbstractEntity

COL_ID, id

Fields inherited from interface IDescriptionProviding

ATTR_BESCHREIBUNG, ATTR_DESCRIPTION, COL_DESCRIPTION

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

ATTR_ID

Fields inherited from interface ILocalizedScopedFilesProviding

ATTR_FILES

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

ATTR_LOCKINGVERSION

Fields inherited from interface INameProviding

ATTR_NAME, COL_NAME

Fields inherited from interface ITransferableEntity

IMPORT_ID, INVALID_ID

Fields inherited from interface 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
void	addFrontendServer(FrontendServer entity)
void	addFrontendServer(MandantFrontendServer entity)
@NotNull ProjectPortalConfig	addProjectPortalConfig(Projekt project)	Adds a new project portal config to this client portal config.
String	getAlias()
String	getBeschreibung()	Deprecated. Use getDescription() instead.
Mandant	getClientScope()	Returns the client scope of this user portal.
Locale	getDefaultLocale()
String	getDescription()
Locale	getFileDefaultLocale()	Gets the default locale for this providing entity.
List<UserPortalFile>	getFiles()	Gets the file entities.
Set<FrontendServer>	getFrontendServers()
Long	getId()
List<UserPortalLocalization>	getLocalizations()	Gets the localized database objects.
Locale	getLocalizationsDefaultLocale()	Gets the default locale for this providing object.
UserPortalLoginConfig	getLoginConfig()
String	getName()
ProjectPortalConfig	getProjectPortalConfig(Projekt project)	Returns the project portal configuration for the given project.
Set<ProjectPortalConfig>	getProjectPortalConfigs()
UserPortalProperties	getProperties()
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()
boolean	isDisablePublicForms()
boolean	isShowAllFormRecords()
UserPortalLocalization	newLocalization()	Creates a new localization object.
void	prePersist()
void	setActive(boolean active)
void	setActiveOnMasterServer(boolean activeOnMasterServer)
void	setAlias(String alias)
void	setClientScope(Mandant clientScope)
void	setDefaultLocale(Locale defaultLocale)
void	setDescription(String description)
void	setDisablePublicForms(boolean disablePublicForms)
void	setFiles(List<UserPortalFile> files)	Sets the file entities.
void	setFrontendServers(Set<FrontendServer> frontendServers)
void	setId(Long id)	!!!
void	setLocalizations(List<UserPortalLocalization> localizations)
void	setLoginConfig(UserPortalLoginConfig loginConfig)
void	setName(String name)
void	setProjectPortalConfigs(Set<ProjectPortalConfig> projectPortalConfigs)
void	setProperties(UserPortalProperties properties)
void	setShowAllFormRecords(boolean showAllFormRecords)
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 AbstractLockableEntity

entityHasChanged, getLockingVersion, setLockingVersion, toString

Methods inherited from class AbstractEntity

asIntValue, isPersisted, setId

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

compareTo, equals, getDBTableName, hashCode

Methods inherited from class Object

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

Methods inherited from interface Comparable

compareTo

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

isPersisted

Methods inherited from interface ILocalizationProviding

getKeys, getLocales, getLocalization, getLocalizationData, setLocalization

Methods inherited from interface ILocalizedScopedFilesProviding

addFile, getFile, getFileData, getFileKeys, getFileLocales, removeFile

Field Details

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_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_PROJECT_PORTAL_CONFIGS

public static final String ATTR_PROJECT_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

ATTR_DEFAULT_LOCALE

public static final String ATTR_DEFAULT_LOCALE

See Also:

• Constant Field Values

ATTR_CLIENT_SCOPE

public static final String ATTR_CLIENT_SCOPE

See Also:

• Constant Field Values

ATTR_SHOW_ALL_FORM_RECORDS

public static final String ATTR_SHOW_ALL_FORM_RECORDS

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_FLAG_SHOW_ALL_FORM_RECORDS

public static final String COL_FLAG_SHOW_ALL_FORM_RECORDS

See Also:

• Constant Field Values

COL_FLAG_DISABLE_PUBLIC_FORMS

public static final String COL_FLAG_DISABLE_PUBLIC_FORMS

See Also:

• Constant Field Values

COL_ALIAS

public static final String COL_ALIAS

See Also:

• Constant Field Values

COL_DEFAULT_LOCALE

public static final String COL_DEFAULT_LOCALE

See Also:

• Constant Field Values

COL_CLIENT_SCOPE_ID

public static final String COL_CLIENT_SCOPE_ID

See Also:

• Constant Field Values

Constructor Details

UserPortal

public UserPortal()

Method Details

getAlias

public String getAlias()

setAlias

public void setAlias(String alias)

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)

getProjectPortalConfigs

public Set<ProjectPortalConfig> getProjectPortalConfigs()

setProjectPortalConfigs

public void setProjectPortalConfigs(Set<ProjectPortalConfig> projectPortalConfigs)

getClientScope

@Nullable
public Mandant getClientScope()

Returns the client scope of this user portal. The client scope is the client for which this user portal is created. If there is a client scope set, the user portal is only available for this client. If there is no client scope set, the user portal is a system scoped user portal.

Returns:

The client scope of this user portal.

setClientScope

public void setClientScope(@Nullable
 Mandant clientScope)

getDefaultLocale

public Locale getDefaultLocale()

setDefaultLocale

public void setDefaultLocale(Locale defaultLocale)

getFileDefaultLocale

public Locale getFileDefaultLocale()

Description copied from interface: ILocalizedScopedFilesProviding

Gets the default locale for this providing entity.

Specified by:

getFileDefaultLocale in interface ILocalizedScopedFilesProviding<UserPortal, UserPortalFile, UserPortalFileData>

Returns:

the default locale for this providing entity.

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.

getFrontendServers

public Set<FrontendServer> getFrontendServers()

setFrontendServers

public void setFrontendServers(Set<FrontendServer> frontendServers)

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

getLocalizations

public List<UserPortalLocalization> getLocalizations()

Description copied from interface: ILocalizationProviding

Gets the localized database objects.

Specified by:

getLocalizations in interface ILocalizationProviding<UserPortal, UserPortalLocalization>

Returns:

the localized database objects

setLocalizations

public void setLocalizations(List<UserPortalLocalization> localizations)

getLocalizationsDefaultLocale

public Locale getLocalizationsDefaultLocale()

Description copied from interface: ILocalizationProviding

Gets the default locale for this providing object.

Specified by:

getLocalizationsDefaultLocale in interface ILocalizationProviding<UserPortal, UserPortalLocalization>

Returns:

the default locale for this providing object

newLocalization

public UserPortalLocalization newLocalization()

Description copied from interface: ILocalizationProviding

Creates a new localization object.

Specified by:

newLocalization in interface ILocalizationProviding<UserPortal, UserPortalLocalization>

Returns:

a new localization object

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)

getProperties

public UserPortalProperties getProperties()

setProperties

public void setProperties(UserPortalProperties properties)

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)

getUserProfiles

public Set<UserProfile> getUserProfiles()

setUserProfiles

public void setUserProfiles(Set<UserProfile> userProfiles)

isActive

public boolean isActive()

setActive

public void setActive(boolean active)

isActiveOnMasterServer

public boolean isActiveOnMasterServer()

setActiveOnMasterServer

public void setActiveOnMasterServer(boolean activeOnMasterServer)

isShowAllFormRecords

public boolean isShowAllFormRecords()

setShowAllFormRecords

public void setShowAllFormRecords(boolean showAllFormRecords)

isDisablePublicForms

public boolean isDisablePublicForms()

setDisablePublicForms

public void setDisablePublicForms(boolean disablePublicForms)

addFrontendServer

public void addFrontendServer(FrontendServer entity)

addFrontendServer

public void addFrontendServer(MandantFrontendServer entity)

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.

addProjectPortalConfig

@NotNull
public @NotNull ProjectPortalConfig addProjectPortalConfig(Projekt project)

Adds a new project portal config to this client portal config.

Parameters:

project - The project to add.

Returns:

The newly created project portal config.

Throws:

IllegalArgumentException - If the project is invalid.

prePersist

public void prePersist()