Package de.xima.fc.mdl.form

Class FormRequest

    • Constructor Detail

      • FormRequest

        public FormRequest​(long projectId,
                   Integer formVersionNumber,
                   String processId,
                   String verifyId,
                   Boolean useFormVersionByFormRecord,
                   FrontendServer frontendServer)
        Creates a new form request data instance with the given parameters.
        Parameters:
        projectId - The database ID of the Projekt.
        formVersionNumber - The version number of the FormVersion, e.g. 1, 2, 3, etc.
        processId - The {@link Vorgang#getProzessId()} of the form record.
        verifyId - Verification ID for double opt-in, can be null.
        useFormVersionByFormRecord - When true, ignore the form version number and use the form version of the form record. When false, use the given form version, or the active version of the project when no form version was given. When null, use the default setting of the project.
        frontendServer - The frontend server to which the form request was directed. null if directed to a master server.
        Since:
        8.6.0

      • FormRequest

        @Deprecated
public FormRequest​(long projektId,
                   Integer formVersionNummer,
                   String prozessId,
                   boolean useFormVersionByVorgang,
                   FrontendServer frontendServer)
        Deprecated.

    • Method Detail

      • getProjektId

        public long getProjektId()

      • setProjektId

        public void setProjektId​(long projektId)

      • getFormVersionNummer

        public Integer getFormVersionNummer()

      • setFormVersionNummer

        public void setFormVersionNummer​(Integer formVersionNummer)

      • getProzessId

        public String getProzessId()

      • setProzessId

        public void setProzessId​(String prozessId)

      • getVerifyId

        public String getVerifyId()

      • setVerifyId

        public void setVerifyId​(String verifyId)

      • setFrontendServer

        public void setFrontendServer​(FrontendServer frontendServer)

      • getUserPortalAlias

        public String getUserPortalAlias()

      • setUserPortalAlias

        public void setUserPortalAlias​(String userPortalAlias)

      • setUseFormVersionByVorgang

        @Deprecated(since="8.6.0")
public void setUseFormVersionByVorgang​(boolean useFormVersionByVorgang)
        Deprecated.

      • isUseFormVersionByVorgang

        @Deprecated(since="8.6.0")
public boolean isUseFormVersionByVorgang()
        Deprecated.

      • isUseFormVersionByFormRecord

        public Boolean isUseFormVersionByFormRecord()
        Gets whether to use the form version of the form record. When false, use either the configured form version, or the active form version of the project.
        Returns:
        Whether to use the form version of the form record.
        Since:
        8.6.0

      • setUseFormVersionByFormRecord

        public void setUseFormVersionByFormRecord​(Boolean useFormVersionByFormRecord)
        Sets whether to use the form version of the form record. When false, use either the configured form version, or the active form version of the project.
        Parameters:
        useFormVersionByFormRecord - Whether to use the form version of the form record.
        Since:
        8.6.0