Package de.xima.fc.entities

Class FormRecordSubmission

java.lang.Object

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

de.xima.fc.entities.AbstractEntity

de.xima.fc.entities.AbstractLockableEntity

de.xima.fc.entities.FormRecordSubmission

All Implemented Interfaces:

de.xima.cmn.dao.interfaces.IEntity<Long>, de.xima.cmn.dao.interfaces.ILockableEntity<Long>, ILockingVersionProviding, ITransferable, ITransferableEntity, ITransferableLockableEntity, Serializable, Comparable<de.xima.cmn.dao.interfaces.IEntity<Long>>

@Entity
public class FormRecordSubmission
extends AbstractLockableEntity

Entity representing a form record submission. Form record submissions may occur in different contexts (e.g. in the inbox, via form provide, in portal).

Since:

8.2.0

Author:

XIMA MEDIA GmbH

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static String	ATTR_FORM_RECORD
static String	ATTR_FORM_RECORD_DATA
static String	ATTR_SUBMIT_CONTEXT
static String	ATTR_SUBMIT_FRONTEND_SERVER_ID
static String	ATTR_SUBMIT_INSTANT
static String	ATTR_SUBMIT_SERVER_BASE_URL
static String	ATTR_SUBMIT_STATE_ID
static String	ATTR_UNIVERSAL_REFERENCE_ID
static String	ATTR_USER_DATA
static String	ATTR_USER_PROFILE_UUID
static String	COL_AUTH_REF
static String	COL_FORM_RECORD_ID
static String	COL_PROFILE_UUID
static String	COL_SUBMIT_CONTEXT
static String	COL_SUBMIT_FRONTEND_SERVER_ID
static String	COL_SUBMIT_SERVER_BASE_URL
static String	COL_SUBMIT_STATE_ID
static String	COL_SUBMIT_TIMESTAMP
static String	COL_USER_DATA

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.ITransferableEntity

IMPORT_ID, INVALID_ID

Constructor Summary

Constructors

Constructor	Description
FormRecordSubmission()

Method Summary

Modifier and Type	Method	Description
void	anonymize()
FormRecordSubmission	cloneBasics()
Vorgang	getFormRecord()
FormEingang	getFormRecordData()	Gets the form record data (= the submitted form data) of this submission.
Long	getId()
String	getSubmitContext()
Long	getSubmitFrontendServerId()
Instant	getSubmitInstant()
String	getSubmitServerBaseUrl()
Long	getSubmitStateId()
String	getUniversalReferenceId()
String	getUserData()	A JSON string with user data of the user at the instant of submitting the form record.
com.alibaba.fastjson.JSONObject	getUserDataJson()	Gets the JSON object with user data of the user at the instant of submitting the form record.
String	getUserDisplayName()
UUID	getUserProfileUuid()
boolean	isSubmitter(IUser user)
void	setFormRecord(Vorgang formRecord)
void	setFormRecordData(FormEingang formRecordData)	Gets the form record data (= the submitted form data) of this submission.
void	setFormRecordData(String formData, IUser user)
void	setSubmitContext(EFormRecordSubmitContext submitContext)
void	setSubmitContext(String submitContext)
void	setSubmitFrontendServer(FrontendServer submitFrontendServer)
void	setSubmitFrontendServerId(Long submitFrontendServerId)
void	setSubmitInstant(Instant submitInstant)
void	setSubmitServerBaseUrl(String submitServerBaseUrl)
void	setSubmitState(WorkflowState submitState)
void	setSubmitStateId(Long submitStateId)
void	setUniversalReferenceId(String universalReferenceId)	Deprecated. Use setUser(IUser) instead.
void	setUser(IUser user)
void	setUserData(com.alibaba.fastjson.JSONObject userData)	A JSON object with user data of the user at the instant of submitting the form record.
void	setUserData(String userData)	A JSON string with user data of the user at the instant of submitting the form record.
void	setUserProfileUuid(UUID userProfileUuid)	Deprecated. Use setUser(IUser) instead.

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

Field Detail

ATTR_FORM_RECORD

public static final String ATTR_FORM_RECORD

See Also:

Constant Field Values

ATTR_FORM_RECORD_DATA

public static final String ATTR_FORM_RECORD_DATA

See Also:

Constant Field Values

ATTR_UNIVERSAL_REFERENCE_ID

public static final String ATTR_UNIVERSAL_REFERENCE_ID

See Also:

Constant Field Values

ATTR_SUBMIT_INSTANT

public static final String ATTR_SUBMIT_INSTANT

See Also:

Constant Field Values

ATTR_SUBMIT_CONTEXT

public static final String ATTR_SUBMIT_CONTEXT

See Also:

Constant Field Values

ATTR_SUBMIT_FRONTEND_SERVER_ID

public static final String ATTR_SUBMIT_FRONTEND_SERVER_ID

See Also:

Constant Field Values

ATTR_SUBMIT_SERVER_BASE_URL

public static final String ATTR_SUBMIT_SERVER_BASE_URL

See Also:

Constant Field Values

ATTR_SUBMIT_STATE_ID

public static final String ATTR_SUBMIT_STATE_ID

See Also:

Constant Field Values

ATTR_USER_PROFILE_UUID

public static final String ATTR_USER_PROFILE_UUID

See Also:

Constant Field Values

ATTR_USER_DATA

public static final String ATTR_USER_DATA

See Also:

Constant Field Values

COL_FORM_RECORD_ID

public static final String COL_FORM_RECORD_ID

See Also:

Constant Field Values

COL_SUBMIT_FRONTEND_SERVER_ID

public static final String COL_SUBMIT_FRONTEND_SERVER_ID

See Also:

Constant Field Values

COL_SUBMIT_SERVER_BASE_URL

public static final String COL_SUBMIT_SERVER_BASE_URL

See Also:

Constant Field Values

COL_AUTH_REF

public static final String COL_AUTH_REF

See Also:

Constant Field Values

COL_SUBMIT_TIMESTAMP

public static final String COL_SUBMIT_TIMESTAMP

See Also:

Constant Field Values

COL_SUBMIT_CONTEXT

public static final String COL_SUBMIT_CONTEXT

See Also:

Constant Field Values

COL_SUBMIT_STATE_ID

public static final String COL_SUBMIT_STATE_ID

See Also:

Constant Field Values

COL_PROFILE_UUID

public static final String COL_PROFILE_UUID

See Also:

Constant Field Values

COL_USER_DATA

public static final String COL_USER_DATA

See Also:

Constant Field Values

Constructor Detail

FormRecordSubmission

public FormRecordSubmission()

Method Detail

getId

public Long getId()

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.

setFormRecordData

public void setFormRecordData(String formData,
                              IUser user)

getUniversalReferenceId

public String getUniversalReferenceId()

setUniversalReferenceId

@Deprecated
public void setUniversalReferenceId(String universalReferenceId)

Deprecated.

Use setUser(IUser) instead.

See Also:

setUser(IUser)

getSubmitInstant

public Instant getSubmitInstant()

setSubmitInstant

public void setSubmitInstant(Instant submitInstant)

getSubmitFrontendServerId

@Nullable
public Long getSubmitFrontendServerId()

setSubmitFrontendServerId

public void setSubmitFrontendServerId(@Nullable
                                      Long submitFrontendServerId)

getSubmitServerBaseUrl

public String getSubmitServerBaseUrl()

setSubmitServerBaseUrl

public void setSubmitServerBaseUrl(String submitServerBaseUrl)

getSubmitContext

public String getSubmitContext()

setSubmitContext

public void setSubmitContext(String submitContext)

setSubmitContext

public void setSubmitContext(EFormRecordSubmitContext submitContext)

getSubmitStateId

@Nullable
public Long getSubmitStateId()

setSubmitStateId

public void setSubmitStateId(@Nullable
                             Long submitStateId)

getUserProfileUuid

@Nullable
public UUID getUserProfileUuid()

setUserProfileUuid

@Deprecated
public void setUserProfileUuid(@Nullable
                               UUID userProfileUuid)

Deprecated.

Use setUser(IUser) instead.

See Also:

setUser(IUser)

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)

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.

getUserDisplayName

public String getUserDisplayName()

setSubmitFrontendServer

public void setSubmitFrontendServer(@Nullable
                                    FrontendServer submitFrontendServer)

setSubmitState

public void setSubmitState(@Nullable
                           WorkflowState submitState)

setUser

public void setUser(IUser user)

isSubmitter

public boolean isSubmitter(IUser user)

anonymize

public void anonymize()

cloneBasics

public FormRecordSubmission cloneBasics()