Class Projekt

java.lang.Object
de.xima.cmn.dao.model.AEntity<Long>
de.xima.fc.entities.AbstractEntity
de.xima.fc.entities.AbstractLockableEntity
de.xima.fc.entities.AbstractMandantDependentEntity
de.xima.fc.entities.Projekt
All Implemented Interfaces:
de.xima.cmn.dao.interfaces.IEntity<Long>, de.xima.cmn.dao.interfaces.ILockableEntity<Long>, ILocalizedScopedFilesProviding<Projekt, ProjectFile, ProjectFileData>, ILocalizationProviding<Projekt, ProjectLocalization>, ICustomAttributeProviding, ICustomAttributesEntity, IDescriptionProviding, ILockingVersionProviding, IMandantDependent, INameProviding, ITransferable, ITransferableEntity, ITransferableLockableEntity, IUUIDEntity, Serializable, Comparable<de.xima.cmn.dao.interfaces.IEntity<Long>>
@Entity public class Projekt extends AbstractMandantDependentEntity implements INameProviding, IDescriptionProviding, IUUIDEntity, ICustomAttributesEntity, ILocalizationProviding<Projekt, ProjectLocalization>, ILocalizedScopedFilesProviding<Projekt, ProjectFile, ProjectFileData>
The entity Projekt contains the core functionality of the system. A project is always associated to one Mandant (client) and contains multiple versions of a form. The form may be instantiated and is then processed by the workflow as configured for this project. The permission setting are respected during workflow processing. Additionally, a project contains various kinds of meta data associated with the form.
See Also:

  • Field Details

  • Constructor Details

    • Projekt

      public Projekt()

  • Method Details

    • getId

      public Long getId()
      Specified by:
      getId in interface de.xima.cmn.dao.interfaces.IEntity<Long>

    • 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)

    • getAlias

      public String getAlias()

    • setAlias

      public void setAlias(String name)

    • getName

      public String getName()
      Specified by:
      getName in interface INameProviding
      Returns:
      The name of this object.

    • setName

      public void setName(String name)

    • getGruppenname

      public String getGruppenname()

    • setGruppenname

      public void setGruppenname(String gruppenname)

    • getDisplayGroupname

      public String getDisplayGroupname()

    • getActiveVersion

      public FormVersion getActiveVersion()

    • setActiveVersion

      public void setActiveVersion(FormVersion activeVersion)

    • getActiveWorkflowVersion

      public WorkflowVersion getActiveWorkflowVersion()
      Returns:
      The workflow version that is currently active, i.e. the version that is used when the workflow is executed.

    • setActiveWorkflowVersion

      public void setActiveWorkflowVersion(WorkflowVersion activeWorkflowVersion)
      Parameters:
      activeWorkflowVersion - The workflow version that is currently active, i.e. the version that is used when the workflow is executed.

    • getBeschreibung

      public String getBeschreibung()
      Specified by:
      getBeschreibung in interface IDescriptionProviding

    • setBeschreibung

      public void setBeschreibung(String beschreibung)

    • getDatumErsterEingang

      public Date getDatumErsterEingang()

    • setDatumErsterEingang

      public void setDatumErsterEingang(Date datumErsterEingang)

    • getDatumLetzterEingang

      public Date getDatumLetzterEingang()

    • setDatumLetzterEingang

      public void setDatumLetzterEingang(Date datumLetzterEingang)

    • getIdentityTokenTemplate

      @Deprecated @Length(max=1024) public @Length(max=1024) String getIdentityTokenTemplate()
      Deprecated.
      Use ProjectIdentityCheckData.getIdentityTokenTemplate().
      Returns:
      The template for generating an identity token.

    • setIdentityTokenTemplate

      @Deprecated public void setIdentityTokenTemplate(String identityTokenTemplate)
      Deprecated.
      Use ProjectIdentityCheckData.setIdentityTokenTemplate(String)
      Parameters:
      identityTokenTemplate - The template for generating an identity token..

    • getDatumVerfuegbarVon

      public Date getDatumVerfuegbarVon()

    • setDatumVerfuegbarVon

      public void setDatumVerfuegbarVon(Date datumVerfuegbarVon)

    • getDatumVerfuegbarBis

      public Date getDatumVerfuegbarBis()

    • setDatumVerfuegbarBis

      public void setDatumVerfuegbarBis(Date datumVerfuegbarBis)

    • getTags

      public List<ProjectTag> getTags()
      Returns:
      A list of user-defined tags that can be used, for example, to search for projects.

    • setTags

      public void setTags(List<ProjectTag> tags)
      Parameters:
      tags - A list of user-defined tags that can be used, for example, to search for projects.

    • getPortalTags

      public List<ProjectPortalTag> getPortalTags(UUID userPortalUuid, Locale locale)
      Parameters:
      locale - The locale to use for sorting the tags.
      Returns:
      A list of all end user tags associated with this project ordered by their display name using the given locale.

    • isAktiv

      public boolean isAktiv()

    • setAktiv

      public void setAktiv(boolean aktiv)

    • getErstelltAm

      public Date getErstelltAm()

    • setErstelltAm

      public void setErstelltAm(Date erstelltAm)

    • getLetzteAenderungAm

      public Date getLetzteAenderungAm()

    • setLetzteAenderungAm

      public void setLetzteAenderungAm(Date letzteAenderungAm)

    • getErstelltVon

      public String getErstelltVon()

    • setErstelltVon

      public void setErstelltVon(String erstelltVon)

    • getLetzteAenderungVon

      public String getLetzteAenderungVon()

    • setLetzteAenderungVon

      public void setLetzteAenderungVon(String letzteAenderungVon)

    • getTitel

      public String getTitel()

    • setTitel

      public void setTitel(String titel)

    • getAccessPassword

      @Deprecated public String getAccessPassword()
      Deprecated.
      the access password is saved within the appropriate ProjectAuthenticatorConfig

    • setAccessPassword

      @Deprecated public void setAccessPassword(String accessPassword)
      Deprecated.
      the access password is saved within the appropriate ProjectAuthenticatorConfig

    • getAccessPasswordV2

      @Deprecated public String getAccessPasswordV2()
      Deprecated.
      the access password is saved within the appropriate ProjectAuthenticatorConfig

    • setAccessPasswordV2

      @Deprecated public void setAccessPasswordV2(String accessPasswordV2)
      Deprecated.
      the access password is saved within the appropriate ProjectAuthenticatorConfig

    • getSubject

      public String getSubject()

    • setSubject

      public void setSubject(String subject)

    • getEndUserSubject

      public String getEndUserSubject()

    • setEndUserSubject

      public void setEndUserSubject(String endUserSubject)

    • getEndUserDetails

      public String getEndUserDetails()

    • setEndUserDetails

      public void setEndUserDetails(String endUserDetails)

    • getScope

      public String getScope()

    • setScope

      public void setScope(String scope)

    • isCustomScope

      public boolean isCustomScope()

    • getFormVersions

      public List<FormVersion> getFormVersions()

    • setFormVersions

      public void setFormVersions(List<FormVersion> formVersions)

    • getWorkflowVersions

      public List<WorkflowVersion> getWorkflowVersions()
      Returns:
      A list of all workflow versions defined for this project.

    • setWorkflowVersions

      public void setWorkflowVersions(List<WorkflowVersion> workflowVersions)
      Parameters:
      workflowVersions - A list of all workflows defined for this project.

    • getBenamungsmodus

      public EBenamungsModus getBenamungsmodus()

    • setBenamungsmodus

      public void setBenamungsmodus(EBenamungsModus benamungsmodus)

    • getBenutzerGruppen

      public List<BenutzerGruppe> getBenutzerGruppen()

    • setBenutzerGruppen

      public void setBenutzerGruppen(List<BenutzerGruppe> benutzerGruppen)

    • getEditorBenutzerGruppen

      public List<BenutzerGruppe> getEditorBenutzerGruppen()

    • setEditorBenutzerGruppen

      public void setEditorBenutzerGruppen(List<BenutzerGruppe> benutzerGruppen)

    • getVisibilityUserGroups

      public List<BenutzerGruppe> getVisibilityUserGroups()

    • setVisibilityUserGroups

      public void setVisibilityUserGroups(List<BenutzerGruppe> userGroups)

    • getMandantFrontendServer

      public List<MandantFrontendServer> getMandantFrontendServer()

    • setMandantFrontendServer

      public void setMandantFrontendServer(List<MandantFrontendServer> mandantfrontendserver)

    • getPostfach

      public Postfach getPostfach()

    • setPostfach

      public void setPostfach(Postfach postfach)

    • getStatusNachWiedervorlage

      @Deprecated public Status getStatusNachWiedervorlage()
      Deprecated.

    • setStatusNachWiedervorlage

      @Deprecated public void setStatusNachWiedervorlage(Status statusNachWiedervorlage)
      Deprecated.

    • isEingangSynchron

      public boolean isEingangSynchron()

    • setEingangSynchron

      public void setEingangSynchron(boolean eingangSynchron)

    • isTemplate

      public boolean isTemplate()

    • setTemplate

      public void setTemplate(boolean template)

    • isHidden

      public boolean isHidden()

    • setHidden

      public void setHidden(boolean hidden)

    • isUsesNewWorkflow

      public boolean isUsesNewWorkflow()

    • getPostfachTemplateString

      public String getPostfachTemplateString()

    • setPostfachTemplateString

      public void setPostfachTemplateString(String postfachTemplateString)

    • getPostfachTemplate

      public PostfachTemplate getPostfachTemplate()

    • setPostfachTemplate

      public void setPostfachTemplate(PostfachTemplate pft)

    • isUsePostfachTemplate

      public boolean isUsePostfachTemplate()

    • setUsePostfachTemplate

      public void setUsePostfachTemplate(boolean usePostfachTemplate)

    • getDataTableTemplateString

      public String getDataTableTemplateString()

    • setDataTableTemplateString

      public void setDataTableTemplateString(String dataTableTemplateString)

    • getDataTableTemplate

      public DataTableTemplate getDataTableTemplate()

    • setDataTableTemplate

      public void setDataTableTemplate(DataTableTemplate dt)

    • isShowChangeStatusBar

      public boolean isShowChangeStatusBar()

    • setShowChangeStatusBar

      public void setShowChangeStatusBar(boolean showchangestatusbar)

    • isFormAuthorizationRequired

      public boolean isFormAuthorizationRequired()

    • isProvideFormAuthentication

      public boolean isProvideFormAuthentication()

    • isProvidePasswordAuthentication

      public boolean isProvidePasswordAuthentication()

    • isProvideAnonmyousAuthentication

      public boolean isProvideAnonmyousAuthentication()

    • isUseNtlmAuthentication

      @Deprecated public boolean isUseNtlmAuthentication()
      Deprecated.

    • setUseNtlmAuthentication

      @Deprecated public void setUseNtlmAuthentication(boolean useNtlm)
      Deprecated.

    • isUseKerberosAuthentication

      public boolean isUseKerberosAuthentication()

    • setUseKerberosAuthentication

      public void setUseKerberosAuthentication(boolean useKerberos)

    • getProjektRessourcen

      public List<ProjektRessource> getProjektRessourcen()

    • setProjektRessourcen

      public void setProjektRessourcen(List<ProjektRessource> ressourcen)

    • getAuthenticatorConfigs

      public List<ProjectAuthenticatorConfig> getAuthenticatorConfigs()

    • setAuthenticatorConfigs

      public void setAuthenticatorConfigs(List<ProjectAuthenticatorConfig> authenticatorConfigs)

    • isAnonymize

      public boolean isAnonymize()
      Gibt an, ob die Protokollierung bei der Verarbeitung des Prozesses 'Formular absenden' anonymisiert ablaufen soll
      Returns:
      the anonymize

    • setAnonymize

      public void setAnonymize(boolean anonymize)

    • getCustomAttributes

      public Map<String,String> getCustomAttributes()
      Description copied from interface: ICustomAttributeProviding
      Gets the map of custom attributes that may be used to store additional information. The stored data depends on the type of the object.
      Specified by:
      getCustomAttributes in interface ICustomAttributeProviding
      Returns:
      The custom attributes.

    • setCustomAttributes

      public void setCustomAttributes(Map<String,String> customAttributes)
      Description copied from interface: ICustomAttributesEntity
      Sets the map of custom attributes that may be used to store additional information. The stored data depends on the type of the object.
      Specified by:
      setCustomAttributes in interface ICustomAttributesEntity
      Parameters:
      customAttributes - The new custom attributes to set.

    • getMessageServiceExtensionProperties

      public Map<String,String> getMessageServiceExtensionProperties()
      Returns the configuration properties of plugin message services by the plugin message service name as a data key.
      Returns:
      The configuration properties of plugin message services.

    • putMessageServiceExtensionProperties

      public void putMessageServiceExtensionProperties(Map<String,String> serviceExtensionProperties)
      Sets the configuration properties of plugin message services by the plugin message service name.
      Parameters:
      serviceExtensionProperties - The configuration properties of plugin message services.

    • getUrlToForm

      public String getUrlToForm()

    • getUrlToProvide

      public String getUrlToProvide()

    • getOfflineModeProvide

      public EFormOfflineMode getOfflineModeProvide()
      Returns:
      Whether a form record belonging to a form that is offline can be opened via the provide link.

    • setOfflineModeProvide

      public void setOfflineModeProvide(EFormOfflineMode offlineModeProvide)
      Parameters:
      offlineModeProvide - Whether a form record belonging to a form that is offline can be opened via the provide link.

    • getOfflineModeReview

      public EFormOfflineMode getOfflineModeReview()
      Returns:
      Whether a form record belonging to a form that is offline can be submitted when opened via the provide link.

    • setOfflineModeReview

      public void setOfflineModeReview(EFormOfflineMode offlineModeReview)
      Parameters:
      offlineModeReview - Whether a form record belonging to a form that is offline can be submitted when opened via the provide link.

    • getThumbnailImage

      public ProjectFile getThumbnailImage(Locale locale)
      Returns the file for the project thumbnail image for the given locale.
      Parameters:
      locale - The locale to get the thumbnail image for.
      Returns:
      The thumbnail image file for the given locale.

    • getLocalizations

      public List<ProjectLocalization> getLocalizations()
      Description copied from interface: ILocalizationProviding
      Gets the localized database objects.
      Specified by:
      getLocalizations in interface ILocalizationProviding<Projekt, ProjectLocalization>
      Returns:
      the localized database objects

    • setLocalizations

      public void setLocalizations(List<ProjectLocalization> localizations)

    • getLocalizationsDefaultLocale

      public Locale getLocalizationsDefaultLocale()
      Description copied from interface: ILocalizationProviding
      Gets the default locale for this providing object.
      Specified by:
      getLocalizationsDefaultLocale in interface ILocalizationProviding<Projekt, ProjectLocalization>
      Returns:
      the default locale for this providing object

    • newLocalization

      public ProjectLocalization newLocalization()
      Description copied from interface: ILocalizationProviding
      Creates a new localization object.
      Specified by:
      newLocalization in interface ILocalizationProviding<Projekt, ProjectLocalization>
      Returns:
      a new localization object

    • getDefaultLocale

      public Locale getDefaultLocale()

    • setDefaultLocale

      public void setDefaultLocale(Locale defaultLocale)

    • isActiveOnServer

      public boolean isActiveOnServer(FrontendServer frontendServer)
      Returns whether the project is active on the given frontend server.
      Parameters:
      frontendServer - The frontend server to check.
      Returns:
      Whether the project is active on the given frontend server.

    • isActiveOnServer

      public boolean isActiveOnServer(MandantFrontendServer mandantFrontendServer)
      Returns whether the project is active on the given client frontend server.
      Parameters:
      mandantFrontendServer - The client frontend server to check.
      Returns:
      Whether the project is active on the given client frontend server.

    • getProjectPortalConfigs

      public Set<ProjectPortalConfig> getProjectPortalConfigs()

    • setProjectPortalConfigs

      public void setProjectPortalConfigs(Set<ProjectPortalConfig> projectPortalConfigs)

    • getProjectPortalConfig

      public ProjectPortalConfig getProjectPortalConfig(UUID portalUuid)

    • getFileDefaultLocale

      public Locale getFileDefaultLocale()
      Description copied from interface: ILocalizedScopedFilesProviding
      Gets the default locale for this providing entity.
      Specified by:
      getFileDefaultLocale in interface ILocalizedScopedFilesProviding<Projekt, ProjectFile, ProjectFileData>
      Returns:
      the default locale for this providing entity.

    • getFiles

      public List<ProjectFile> getFiles()
      Description copied from interface: ILocalizedScopedFilesProviding
      Gets the file entities.
      Specified by:
      getFiles in interface ILocalizedScopedFilesProviding<Projekt, ProjectFile, ProjectFileData>
      Returns:
      the file entities

    • setFiles

      public void setFiles(List<ProjectFile> files)
      Description copied from interface: ILocalizedScopedFilesProviding
      Sets the file entities.
      Specified by:
      setFiles in interface ILocalizedScopedFilesProviding<Projekt, ProjectFile, ProjectFileData>
      Parameters:
      files - the file entities to set.

    • getDefaultUserPortalId

      public Long getDefaultUserPortalId()

    • setDefaultUserPortalId

      public void setDefaultUserPortalId(Long defaultUserPortalId)

    • getDisplayName

      public String getDisplayName(Locale locale)
      Returns the display name of the project for the locale.
      Parameters:
      locale - The locale to get the display name for.
      Returns:
      The display name of the project for the given locale.

    • getDescription

      public String getDescription(Locale locale)
      Returns the description of the project for the given locale.
      Parameters:
      locale - The locale to get the description for.
      Returns:
      The description of the project for the given locale.

    • getShortDescription

      public String getShortDescription(Locale locale)
      Returns the short description of the project for the locale.
      Parameters:
      locale - The locale to get the short description for.
      Returns:
      The short description of the project for the given locale.

    • isFormRecordDataHistoryEnabled

      public boolean isFormRecordDataHistoryEnabled()

    • setFormRecordDataHistoryEnabled

      public void setFormRecordDataHistoryEnabled(boolean formRecordDataHistoryEnabled)

    • isOnline

      @Deprecated public boolean isOnline()
      Deprecated.
      Use ProjektUtils.isOffline(Projekt, WorkflowVersion).
      Returns:
      Whether the project is currently online.

    • getDataTableName

      @Deprecated public String getDataTableName()
      Deprecated.

    • setDataTableName

      @Deprecated public void setDataTableName(String dataTableName)
      Deprecated.
      TODO: wird momentan nicht gebraucht Zeitnah aus Entität entfernen? Der projektspezifische Tabellenname muss aus dem Enum EProjectSpecificDBTable entnommen werden

    • getDeprecatedNTLMSetting

      @Deprecated public Boolean getDeprecatedNTLMSetting()
      Deprecated.

    • getDeprecatedKerberosSetting

      @Deprecated public Boolean getDeprecatedKerberosSetting()
      Deprecated.

    • addTag

      public void addTag(ProjectTag tag)

    • removeTag

      public void removeTag(ProjectTag tag)

    • addWorkflowVersion

      public void addWorkflowVersion(WorkflowVersion version)
      Adds the given workflow version and sets the WorkflowVersion.getProject() to this project.
      Parameters:
      version - Workflow version to add.

    • addFormVersion

      public void addFormVersion(FormVersion formVersion)

    • removeFormVersion

      public void removeFormVersion(FormVersion formVersion)

    • removeWorkflowVersion

      public void removeWorkflowVersion(WorkflowVersion workflowVersion)

    • addBenutzerGruppe

      public void addBenutzerGruppe(BenutzerGruppe benutzerGruppe)

    • removeBenutzerGruppen

      public void removeBenutzerGruppen(BenutzerGruppe benutzerGruppe)

    • addEditorBenutzerGruppe

      public void addEditorBenutzerGruppe(BenutzerGruppe benutzerGruppe)

    • removeEditorBenutzerGruppen

      public void removeEditorBenutzerGruppen(BenutzerGruppe benutzerGruppe)

    • addVisibilityUsergroup

      public void addVisibilityUsergroup(BenutzerGruppe userGroup)

    • removeVisibilityUserGroup

      public void removeVisibilityUserGroup(BenutzerGruppe userGroup)

    • addMandantFrontendServer

      public void addMandantFrontendServer(MandantFrontendServer mandantfrontendserver)

    • removeMandantFrontendServer

      public void removeMandantFrontendServer(MandantFrontendServer mandantfrontendserver)

    • addProjektRessource

      public void addProjektRessource(ProjektRessource ressource)

    • removeProjektRessource

      public void removeProjektRessource(ProjektRessource ressource)

    • addAuthentificatorConfig

      public void addAuthentificatorConfig(ProjectAuthenticatorConfig authenticatorConfig)

    • removeAuthentificatorConfig

      public void removeAuthentificatorConfig(ProjectAuthenticatorConfig authenticatorConfigs)

    • isEditableBy

      @Deprecated public boolean isEditableBy(Benutzer user, List<BenutzerGruppe> usergroups)
      Deprecated.
      Use UserMgmtUtils.canEditProject(de.xima.fc.interfaces.user.IUser, Projekt) instead.
      Parameters:
      user - User to check.
      usergroups - User groups of the user. Do not simply call Benutzer.getBenutzerGruppen(), use IBenutzerDao#getBenutzergruppen which handles virtual users correctly.
      Returns:
      Whether the user with the user groups is allowed to edit this project.

    • isVisibleBy

      @Deprecated public boolean isVisibleBy(Benutzer user, List<BenutzerGruppe> usergroups)
      Deprecated.
      Benutzer is deprecated. Use UserMgmtUtils.canViewProject(de.xima.fc.interfaces.user.IUser, Projekt) instead.

    • cloneBasics

      public Projekt cloneBasics()