Package de.xima.fc.entities

Class FormRecordSubmission

    • Constructor Detail

      • FormRecordSubmission

        public FormRecordSubmission()

    • Method Detail

      • anonymize

        public void anonymize()

      • getFormRecord

        public Vorgang getFormRecord()

      • setFormRecord

        public void setFormRecord​(Vorgang formRecord)

      • getFormRecordData

        @Nullable
public FormEingang getFormRecordData()
        Gets the form record data (= the submitted form data) of this submission. Note that this may be null, not all submissions store form data. If you wish to access the latest available form data, search for the latest submission with form data.
        Returns:
        The form record data of this submission, or null if no form data is available.

      • setFormRecordData

        public void setFormRecordData​(@Nullable
                              FormEingang formRecordData)
        Gets the form record data (= the submitted form data) of this submission. Note that this may be null, not all submissions store form data. If you wish to access the latest available form data, search for the latest submission with form data.
        Parameters:
        formRecordData - The form record data of this submission, or null if no form data is available.

      • getId

        public Long getId()

      • getLoginServiceClientName

        public String getLoginServiceClientName()
        Gets the name of the login service client that the user was authenticated with at the instant of submitting the form record.
        Returns:
        The name of the login service client.

      • getSubmitContext

        public String getSubmitContext()

      • setSubmitContext

        public void setSubmitContext​(String submitContext)

      • getSubmitLocale

        @Nullable
public Locale getSubmitLocale()
        The language the form record was submitted in. This can be null if the language is unknown.
        Returns:
        The language the form record was submitted in.

      • setSubmitLocale

        public void setSubmitLocale​(@Nullable
                            Locale submitLanguage)

      • getSubmitFrontendServerId

        @Nullable
public Long getSubmitFrontendServerId()

      • setSubmitFrontendServerId

        public void setSubmitFrontendServerId​(@Nullable
                                      Long submitFrontendServerId)

      • getSubmitInstant

        public Instant getSubmitInstant()

      • setSubmitInstant

        public void setSubmitInstant​(Instant submitInstant)

      • getSubmitServerBaseUrl

        public String getSubmitServerBaseUrl()

      • setSubmitServerBaseUrl

        public void setSubmitServerBaseUrl​(String submitServerBaseUrl)

      • getSubmitStateId

        @Nullable
public Long getSubmitStateId()

      • setSubmitStateId

        public void setSubmitStateId​(@Nullable
                             Long submitStateId)

      • getUniversalReferenceId

        public String getUniversalReferenceId()

      • getUserData

        public String getUserData()
        A JSON string with user data of the user at the instant of submitting the form record.
        Returns:
        The user data as a JSON string.

      • setUserData

        public void setUserData​(String userData)
        A JSON string with user data of the user at the instant of submitting the form record.

        Use setUser(IUser) instead.

        Parameters:
        userData - The user data as a JSON string.
        See Also:
        setUser(IUser)

      • setUserData

        public void setUserData​(com.alibaba.fastjson.JSONObject userData)
        A JSON object with user data of the user at the instant of submitting the form record.

        Use setUser(IUser) instead.

        Parameters:
        userData - The user data as a JSON object.
        See Also:
        setUser(IUser)

      • getUserData

        public Object getUserData​(String attributeName)

      • getUserDataJson

        public com.alibaba.fastjson.JSONObject getUserDataJson()
        Gets the JSON object with user data of the user at the instant of submitting the form record.
        Returns:
        A JSON object with the user data.

      • getUserDataString

        public String getUserDataString​(String attributeName)

      • getUserDisplayName

        public String getUserDisplayName()

      • getUserEmail

        public String getUserEmail()

      • getUserIdpId

        public String getUserIdpId()
        Gets the ID of the user within the identity provider at the instant of submitting the form record.
        Returns:
        The ID of the user within the identity provider.

      • getUserProfileUuid

        @Nullable
public UUID getUserProfileUuid()

      • isSubmitter

        public boolean isSubmitter​(IUser user)
        Checks if the given user is the same as the user of this submission.
        Parameters:
        user - The user to check.
        Returns:
        true if the given user is the same as the user of this submission, false otherwise.

      • isSubmitter

        public boolean isSubmitter​(IUserRef userRef)
        Checks if the given user reference is the same as the user reference of this submission.
        Parameters:
        userRef - The user reference to check.
        Returns:
        true if the given user reference is the same as the user reference of this submission, false otherwise.

      • setFormRecordData

        public void setFormRecordData​(String formData,
                              IUser user)

      • setSubmitFrontendServer

        public void setSubmitFrontendServer​(@Nullable
                                    FrontendServer submitFrontendServer)

      • setSubmitState

        public void setSubmitState​(@Nullable
                           WorkflowState submitState)

      • setUser

        public void setUser​(IUser user)

      • setUser

        public void setUser​(IUser user,
                    Mandant client)