Package de.xima.fc.entities

Class ClientPortalConfig

java.lang.Object

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

de.xima.fc.entities.AbstractEntity

de.xima.fc.entities.AbstractLockableEntity

de.xima.fc.entities.ALockableEntity

de.xima.fc.entities.AClientDependentEntity

de.xima.fc.entities.ClientPortalConfig

All Implemented Interfaces:

de.xima.cmn.dao.interfaces.IEntity<Long>, de.xima.cmn.dao.interfaces.ILockableEntity<Long>, ILocalizedScopedFilesProviding<ClientPortalConfig,ClientPortalConfigFile,ClientPortalConfigFileData>, ILocalizationProviding<ClientPortalConfig,ClientPortalConfigLocalization>, ILockingVersionProviding, IMandantDependent, ITransferable, ITransferableEntity, ITransferableLockableEntity, Serializable, Comparable<de.xima.cmn.dao.interfaces.IEntity<Long>>

@Entity
public class ClientPortalConfig
extends AClientDependentEntity
implements ILocalizationProviding<ClientPortalConfig,ClientPortalConfigLocalization>, ILocalizedScopedFilesProviding<ClientPortalConfig,ClientPortalConfigFile,ClientPortalConfigFileData>

Entity model for client portal config.

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_FILES
static String	ATTR_LOCALIZATIONS
static String	ATTR_PROJECT_PORTAL_CONFIGS
static String	ATTR_USER_PORTAL
static String	COL_FLAG_ACTIVE
static String	COL_PORTAL_ID

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

COL_CLIENTID, mandant

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.cmn.dao.interfaces.ILockableEntity

ATTR_LOCKINGVERSION

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

ATTR_CLIENT, ATTR_MANDANT, COL_CLIENT_ID

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

IMPORT_ID, INVALID_ID

Constructor Summary

Constructors

Constructor	Description
ClientPortalConfig()

Method Summary

Modifier and Type	Method	Description
@NotNull ProjectPortalConfig	addProjectPortalConfig(Projekt project)	Adds a new project portal config to this client portal config.
Locale	getFallbackLocale()	Gets the default locale to use as a fallback when a localization is missing for a locale.
List<ClientPortalConfigFile>	getFiles()	Gets the file entities.
Long	getId()
List<ClientPortalConfigLocalization>	getLocalizations()	Gets the localisation entities
ProjectPortalConfig	getProjectPortalConfig(long projectId)	Returns the project portal config for the given project.
ProjectPortalConfig	getProjectPortalConfig(Projekt project)	Returns the project portal config for the given project.
List<ProjectPortalConfig>	getProjectPortalConfigs()
UserPortal	getUserPortal()
boolean	isActive()
void	setActive(boolean active)
void	setFiles(List<ClientPortalConfigFile> files)	Sets the file entities.
void	setLocalizations(List<ClientPortalConfigLocalization> localizations)	Sets the i18n name
void	setProjectPortalConfigs(List<ProjectPortalConfig> projectPortalConfigs)
void	setUserPortal(UserPortal userPortal)

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

getMandant, setMandant

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

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

COL_PORTAL_ID

public static final String COL_PORTAL_ID

See Also:

Constant Field Values

COL_FLAG_ACTIVE

public static final String COL_FLAG_ACTIVE

See Also:

Constant Field Values

ATTR_ACTIVE

public static final String ATTR_ACTIVE

See Also:

Constant Field Values

ATTR_USER_PORTAL

public static final String ATTR_USER_PORTAL

See Also:

Constant Field Values

ATTR_PROJECT_PORTAL_CONFIGS

public static final String ATTR_PROJECT_PORTAL_CONFIGS

See Also:

Constant Field Values

ATTR_FILES

public static final String ATTR_FILES

See Also:

Constant Field Values

ATTR_LOCALIZATIONS

public static final String ATTR_LOCALIZATIONS

See Also:

Constant Field Values

Constructor Detail

ClientPortalConfig

public ClientPortalConfig()

Method Detail

getId

public Long getId()

Specified by:

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

getUserPortal

public UserPortal getUserPortal()

setUserPortal

public void setUserPortal(UserPortal userPortal)

isActive

public boolean isActive()

setActive

public void setActive(boolean active)

getFiles

public List<ClientPortalConfigFile> getFiles()

Description copied from interface: ILocalizedScopedFilesProviding

Gets the file entities.

Specified by:

getFiles in interface ILocalizedScopedFilesProviding<ClientPortalConfig,ClientPortalConfigFile,ClientPortalConfigFileData>

Returns:

the file entities

setFiles

public void setFiles(List<ClientPortalConfigFile> files)

Description copied from interface: ILocalizedScopedFilesProviding

Sets the file entities.

Specified by:

setFiles in interface ILocalizedScopedFilesProviding<ClientPortalConfig,ClientPortalConfigFile,ClientPortalConfigFileData>

Parameters:

files - the file entities to set.

getLocalizations

public List<ClientPortalConfigLocalization> getLocalizations()

Description copied from interface: ILocalizationProviding

Gets the localisation entities

Specified by:

getLocalizations in interface ILocalizationProviding<ClientPortalConfig,ClientPortalConfigLocalization>

Returns:

the localisation entities

setLocalizations

public void setLocalizations(List<ClientPortalConfigLocalization> localizations)

Description copied from interface: ILocalizationProviding

Sets the i18n name

Specified by:

setLocalizations in interface ILocalizationProviding<ClientPortalConfig,ClientPortalConfigLocalization>

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<ClientPortalConfig,ClientPortalConfigLocalization>

Specified by:

getFallbackLocale in interface ILocalizedScopedFilesProviding<ClientPortalConfig,ClientPortalConfigFile,ClientPortalConfigFileData>

Returns:

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

getProjectPortalConfigs

public List<ProjectPortalConfig> getProjectPortalConfigs()

setProjectPortalConfigs

public void setProjectPortalConfigs(List<ProjectPortalConfig> projectPortalConfigs)

getProjectPortalConfig

public ProjectPortalConfig getProjectPortalConfig(Projekt project)

Returns the project portal config 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.

getProjectPortalConfig

public ProjectPortalConfig getProjectPortalConfig(long projectId)

Returns the project portal config for the given project.

Parameters:

projectId - The ID 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.