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:
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final StringFields inherited from class AbstractLockableEntity
COL_LOCKINGVERSION, lockingVersionFields inherited from class AbstractEntity
COL_ID, idFields inherited from interface IDescriptionProviding
ATTR_BESCHREIBUNG, ATTR_DESCRIPTION, COL_DESCRIPTIONFields inherited from interface de.xima.cmn.dao.interfaces.IEntity
ATTR_IDFields inherited from interface ILocalizedScopedFilesProviding
ATTR_FILESFields inherited from interface de.xima.cmn.dao.interfaces.ILockableEntity
ATTR_LOCKINGVERSIONFields inherited from interface INameProviding
ATTR_NAME, COL_NAMEFields inherited from interface ITransferableEntity
IMPORT_ID, INVALID_IDFields 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 -
Method Summary
Modifier and TypeMethodDescriptionvoidaddFrontendServer(FrontendServer entity) void@NotNull ProjectPortalConfigaddProjectPortalConfig(Projekt project) Adds a new project portal config to this client portal config.getAlias()Deprecated.Returns the client scope of this user portal.Gets the default locale for this providing entity.getFiles()Gets the file entities.getId()Gets the localized database objects.Gets the default locale for this providing object.getName()getProjectPortalConfig(Projekt project) Returns the project portal configuration for the given project.getUUID()Gets the UUID (universal unique identifier) that uniquely identifies this type of entity.Gets the UUID (universal unique identifier) that uniquely identifies this type of entity.booleanisActive()booleanbooleanbooleanCreates a new localization object.voidvoidsetActive(boolean active) voidsetActiveOnMasterServer(boolean activeOnMasterServer) voidvoidsetClientScope(Mandant clientScope) voidsetDefaultLocale(Locale defaultLocale) voidsetDescription(String description) voidsetDisablePublicForms(boolean disablePublicForms) voidsetFiles(List<UserPortalFile> files) Sets the file entities.voidsetFrontendServers(Set<FrontendServer> frontendServers) void!!!voidsetLocalizations(List<UserPortalLocalization> localizations) voidsetLoginConfig(UserPortalLoginConfig loginConfig) voidvoidsetProjectPortalConfigs(Set<ProjectPortalConfig> projectPortalConfigs) voidsetProperties(UserPortalProperties properties) voidsetShowAllFormRecords(boolean showAllFormRecords) voidsetUserProfiles(Set<UserProfile> userProfiles) voidSets the UUID (universal unique identifier) that uniquely identifies this type of entity.voidsetUUIDObject(UUID uuid) Methods inherited from class AbstractLockableEntity
entityHasChanged, getLockingVersion, setLockingVersion, toStringMethods inherited from class AbstractEntity
asIntValue, isPersisted, setIdMethods inherited from class de.xima.cmn.dao.model.AEntity
compareTo, equals, getDBTableName, hashCodeMethods inherited from interface Comparable
compareToMethods inherited from interface de.xima.cmn.dao.interfaces.IEntity
isPersistedMethods inherited from interface ILocalizationProviding
getKeys, getLocales, getLocalization, getLocalizationData, setLocalizationMethods inherited from interface ILocalizedScopedFilesProviding
addFile, getFile, getFileData, getFileKeys, getFileLocales, removeFile
-
Field Details
-
ATTR_ALIAS
- See Also:
-
ATTR_ACTIVE
- See Also:
-
ATTR_ACTIVE_ON_MASTER_SERVER
- See Also:
-
ATTR_LOGIN_CONFIG
- See Also:
-
ATTR_FRONTEND_SERVERS
- See Also:
-
ATTR_PROJECT_PORTAL_CONFIGS
- See Also:
-
ATTR_AUTHENTICATOR_CONFIGS
- See Also:
-
ATTR_TAGS
- See Also:
-
ATTR_USER_PROFILES
- See Also:
-
ATTR_DEFAULT_LOCALE
- See Also:
-
ATTR_CLIENT_SCOPE
- See Also:
-
ATTR_SHOW_ALL_FORM_RECORDS
- See Also:
-
COL_FLAG_ACTIVE
- See Also:
-
COL_FLAG_ACTIVE_ON_MS
- See Also:
-
COL_FLAG_SHOW_ALL_FORM_RECORDS
- See Also:
-
COL_FLAG_DISABLE_PUBLIC_FORMS
- See Also:
-
COL_ALIAS
- See Also:
-
COL_DEFAULT_LOCALE
- See Also:
-
COL_CLIENT_SCOPE_ID
- See Also:
-
-
Constructor Details
-
UserPortal
public UserPortal()
-
-
Method Details
-
getAlias
-
setAlias
-
getBeschreibung
Deprecated.UsegetDescription()instead.- Specified by:
getBeschreibungin interfaceIDescriptionProviding- See Also:
-
getDescription
- Specified by:
getDescriptionin interfaceIDescriptionProviding- Returns:
- A human-readable description for this object.
-
setDescription
-
getProjectPortalConfigs
-
setProjectPortalConfigs
-
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
-
getDefaultLocale
-
setDefaultLocale
-
getFileDefaultLocale
Description copied from interface:ILocalizedScopedFilesProvidingGets the default locale for this providing entity.- Specified by:
getFileDefaultLocalein interfaceILocalizedScopedFilesProviding<UserPortal, UserPortalFile, UserPortalFileData>- Returns:
- the default locale for this providing entity.
-
getFiles
Description copied from interface:ILocalizedScopedFilesProvidingGets the file entities.- Specified by:
getFilesin interfaceILocalizedScopedFilesProviding<UserPortal, UserPortalFile, UserPortalFileData>- Returns:
- the file entities
-
setFiles
Description copied from interface:ILocalizedScopedFilesProvidingSets the file entities.- Specified by:
setFilesin interfaceILocalizedScopedFilesProviding<UserPortal, UserPortalFile, UserPortalFileData>- Parameters:
files- the file entities to set.
-
getFrontendServers
-
setFrontendServers
-
getId
-
setId
Description copied from class:AbstractEntity!!!WARNING: Currently values biggerInteger.MAX_VALUEor lower thenInteger.MIN_VALUEwill be altered to null!!!- Specified by:
setIdin interfacede.xima.cmn.dao.interfaces.IEntity<Long>- Overrides:
setIdin classAbstractEntity- Parameters:
id-Longthe database-id to set
-
getLocalizations
Description copied from interface:ILocalizationProvidingGets the localized database objects.- Specified by:
getLocalizationsin interfaceILocalizationProviding<UserPortal, UserPortalLocalization>- Returns:
- the localized database objects
-
setLocalizations
-
getLocalizationsDefaultLocale
Description copied from interface:ILocalizationProvidingGets the default locale for this providing object.- Specified by:
getLocalizationsDefaultLocalein interfaceILocalizationProviding<UserPortal, UserPortalLocalization>- Returns:
- the default locale for this providing object
-
newLocalization
Description copied from interface:ILocalizationProvidingCreates a new localization object.- Specified by:
newLocalizationin interfaceILocalizationProviding<UserPortal, UserPortalLocalization>- Returns:
- a new localization object
-
getLoginConfig
-
setLoginConfig
-
getName
- Specified by:
getNamein interfaceINameProviding- Returns:
- The name of this object.
-
setName
-
getProperties
-
setProperties
-
getUUID
Description copied from interface:IUUIDEntityGets 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 exampleclient scopesorproject scope.- Specified by:
getUUIDin interfaceIUUIDEntity- Returns:
- The UUID of the entity.
-
setUUID
Description copied from interface:IUUIDEntitySets 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 exampleclient scopesorproject scope.- Specified by:
setUUIDin interfaceIUUIDEntity- Parameters:
uuid- The UUID of the entity.
-
getUUIDObject
Description copied from interface:IUUIDEntityGets 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 exampleclient scopesorproject scope.- Specified by:
getUUIDObjectin interfaceIUUIDEntity- Returns:
- The UUID of the entity.
-
setUUIDObject
-
getUserProfiles
-
setUserProfiles
-
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
-
addFrontendServer
-
getProjectPortalConfig
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
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()
-
getDescription()instead.