Class Vorgang
java.lang.Object
de.xima.cmn.dao.model.AEntity<Long>
- All Implemented Interfaces:
de.xima.cmn.dao.interfaces.IEntity<Long>, de.xima.cmn.dao.interfaces.ILockableEntity<Long>, ICustomAttributeProviding, ICustomAttributesEntity, ILockingVersionProviding, IMandantDependent, IProjektDependent, ITransferable, ITransferableEntity, ITransferableLockableEntity, IUUIDEntity, Serializable, Comparable<de.xima.cmn.dao.interfaces.IEntity<Long>>
@Entity
public class Vorgang
extends AClientDependentEntity
implements IProjektDependent, IUUIDEntity, ICustomAttributesEntity
A form record (Vorgang) is a record of a
form submission. When a form is submitted initially, a new
form record is created. Users may open an existing form record, edit its data, and submit it again.
A form record is identified by its UUID, also called process ID. It is globally unique among
all projects and clients, and identifies the form record in the system.
Each form record is associated with a workflow state, which represents business
logic and defines the possible actions that can be taken on the form record.
The submissions store a list of all form record submissions. Each time a user submits a
form, a new form record submission is created. Each form submission contains some metadata such as the user who
submitted the form, and also references the form data for all form fields.
- Author:
- XIMA MEDIA GmbH
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final Stringstatic final Stringstatic final StringDeprecated.static final Stringstatic final StringDeprecated.static final StringDeprecated.static final StringDeprecated.user information of the creator is now stored in theinitial form record submissionstatic final StringDeprecated.user information of the creator is now stored in theinitial form record submissionstatic final StringDeprecated.the form record data belongs to asubmission.static final Stringstatic final StringDeprecated.user information of the last editor is now stored in thelast form record submissionstatic final StringDeprecated.user information of the last editor is now stored in thelast form record submissionstatic final StringDeprecated.user information of the last editor is now stored in thelast form record submissionstatic final Stringstatic final Stringstatic final StringDeprecated.user information of the creator is now stored in theinitial form record submissionstatic final Stringstatic final StringDeprecated.static final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final StringDeprecated.The lastStatusChangeDate will be persisted in the lastFormRecordSubmission.static final Stringstatic final StringDeprecated.static final Stringstatic final Stringstatic final Stringstatic final StringDeprecated.UseFormRecordSubmission.ATTR_SUBMIT_SERVER_BASE_URLinstead.static final StringDeprecated.UseFormRecordSubmission.ATTR_SUBMIT_FRONTEND_SERVER_IDinstead.static final Stringstatic final StringDeprecated.static final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final StringDeprecated.The lastStatusChangeDate will be perssited in the lastFormRecordSubmission.static final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final StringDeprecated.the form record data belongs to asubmission.static final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final StringDeprecated.UseFormRecordSubmission.getSubmitFrontendServerId()instead.static final StringDeprecated.UseFormRecordSubmission.getSubmitServerBaseUrl()instead.static final Stringstatic final Stringstatic final StringDeprecated.user information of the creator is now stored in theinitial form record submissionstatic final StringDeprecated.user information of the last editor is now stored in thelast form record submissionstatic final StringDeprecated.user information of the creator is now stored in theinitial form record submissionstatic final StringDeprecated.user information of the last editor is now stored in thelast form record submissionstatic final StringDeprecated.user information of the creator is now stored in theinitial form record submissionstatic final StringDeprecated.user information of the last editor is now stored in thelast form record submissionstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final intstatic final StringFields inherited from class AClientDependentEntity
COL_CLIENTID, mandantFields inherited from class AbstractLockableEntity
COL_LOCKINGVERSION, lockingVersionFields inherited from class AbstractEntity
COL_ID, idFields inherited from interface ICustomAttributesEntity
ATTR_CUSTOM_ATTRIBUTES, COL_CUSTOM_ATTRIBUTE_NAME, COL_CUSTOM_ATTRIBUTE_VALUEFields inherited from interface de.xima.cmn.dao.interfaces.IEntity
ATTR_IDFields inherited from interface de.xima.cmn.dao.interfaces.ILockableEntity
ATTR_LOCKINGVERSIONFields inherited from interface IMandantDependent
ATTR_CLIENT, ATTR_MANDANT, COL_CLIENT_IDFields inherited from interface ITransferableEntity
IMPORT_ID, INVALID_IDFields inherited from interface IUUIDEntity
INVALID_UUID, INVALID_UUID_OBJECT, NULL_SAFE_UUID_TYPE, NULLABLE_UUID_TYPE, TYPE_NAME_UUID -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidaddAttachment(Attachment attachment) voidDeprecated.voidaddFormeingang(FormEingang formeingang) Deprecated.voidaddSubmission(IUser user, EFormRecordSubmitContext submitContext, FrontendServer submitFrontendServer, String submitServerBaseUrl, String formData, boolean newDataEntry) Deprecated.voidaddSubmission(IUser user, EFormRecordSubmitContext submitContext, FrontendServer submitFrontendServer, String submitServerBaseUrl, Locale submitLocale, String formData, boolean newDataEntry) Adds a new submission to the form record.voidDeprecated.Deprecated.getChats()Deprecated.Can be extremely slow !!!com.alibaba.fastjson.JSONObjectprotected StringDeprecated.UsegetInitialSubmission()instead.Deprecated.Deprecated.Use thegetCurrentWorkflowState()together with the new workflow engine.Gets the map of custom attributes that may be used to store additional information.A list of custom key-value pairs, similar togetCustomAttributes().Returns the display name of this form record for endusers.getDisplayName(Locale locale) Returns the display name of this form record for endusers.com.alibaba.fastjson.JSONObjectprotected StringDeprecated.UsegetLastSubmission()instead.Deprecated.Deprecated.Deprecated.intDeprecated.Deprecated.UseFormRecordSubmission.getSubmitFrontendServerId()instead.getId()Deprecated.Deprecated.usegetParentId()Deprecated.UseFormRecordSubmission.getSubmitServerBaseUrl()instead.intgetUnreadChatCount(IUser user) Returns the number of unread chat messages for the given user.intgetUnreadChatCount(IUserRef user) Returns the number of unread chats for the given user.intgetUnreadMessageCount(IUser user) Returns the number of unread chat messages for the given user.intReturns the number of unread chat messages for the given user.getUUID()Gets the UUID of this form record.Gets the UUID of this form record.booleanbooleanbooleanbooleanbooleanVorgänge sind löschbar, wenn der Status, in dem sie sich befinden, das Löschen von Vorgängen erlaubt.booleanisSaved()booleanDeprecated.booleanbooleanvoidremoveAttachment(Attachment attachment) voidremoveChild(Vorgang vorgang) Deprecated.voidremoveFormeingang(FormEingang formeingang) Deprecated.voidsetAccesses(List<FormRecordAccess> formRecordAccesses) voidsetAttachments(List<Attachment> attachments) voidsetBearbeiter(Benutzer bearbeiter) Deprecated.voidsetBearbeiterRef(String bearbeiterRef) Deprecated.voidsetChats(List<FormRecordChat> chats) voidsetChildren(List<Vorgang> children) Deprecated.Can be extremely slow !!!voidsetCreator(Benutzer creator) Deprecated.UsesetCreator(IUser)instead.voidsetCreator(IUser creator) Deprecated.voidsetCreatorData(com.alibaba.fastjson.JSONObject creatorData) Deprecated.UsegetInitialSubmission()instead.protected voidsetCreatorDataString(String creatorData) Deprecated.UsegetInitialSubmission()instead.voidsetCreatorProfileUuid(UUID creatorProfileUuid) Deprecated.Does nothing.voidsetCreatorRef(String creatorRef) Deprecated.UsegetInitialSubmission()instead.voidsetCurrentFormeingang(FormEingang currentFormeingang) Deprecated.voidsetCurrentPostfach(Postfach currentPostfach) voidsetCurrentStatus(Status status) Deprecated.Use thesetCurrentWorkflowState(WorkflowState)together with the new workflow engine.voidsetCurrentWorkflowState(WorkflowState currentWorkflowState) Deprecated.For Hibernate only, in most cases you should usesetNewWorkflowState(WorkflowState).voidsetCustomAttributes(Map<String, String> customAttributes) Sets the map of custom attributes that may be used to store additional information.voidsetCustomData(Map<String, String> customData) A list of custom key-value pairs, similar togetCustomAttributes().voidDeprecated.UsesetEditor(IUser)instead.voidDeprecated.voidsetEditorData(com.alibaba.fastjson.JSONObject editorData) Deprecated.UsegetLastSubmission()instead.protected voidsetEditorDataString(String editorData) Deprecated.UsegetInitialSubmission()instead.voidsetEditorProfileUuid(UUID editorProfileUuid) Deprecated.Does nothing.voidsetEditorRef(String editorRef) Deprecated.UsegetLastSubmission()instead.voidsetEingangsDatum(Date eingangsDatum) Deprecated.For Hibernate only, in most cases you should usesetNewEingangsDatum(Date).voidsetEndUserDetails(String endUserDetails) voidsetEndUserSubject(String endUserSubject) voidsetErsteller(Benutzer ersteller) Deprecated.voidsetErstellerRef(String erstellerRef) Deprecated.voidsetFehlerAnzahl(int fehlerAnzahl) voidsetFormData(String formData) voidsetFormeingaenge(List<FormEingang> formeingaenge) Deprecated.voidsetFormVersion(FormVersion formVersion) voidsetFrontendserver_id(Long quellserver_id) Deprecated.voidsetGelesen(boolean gelesen) void!!!voidsetIdentityToken(String identityToken) voidsetInArbeit(boolean inArbeit) voidsetLastStatusChangeDate(Date lastStatusChangeDate) Deprecated.For Hibernate only, in most cases you should usesetNewLastStatusChangeDate(Date).voidsetNewEingangsDatum(Date newEingangsDatum) Sets the new date when the form record was created and stores the info whether it was changed.voidsetNewLastStatusChangeDate(Date newLastStatusChangeDate) Sets the new date when the last status changed occurred and stores the info whether it was changed.voidsetNewStatus(Status newStatus) Deprecated.voidsetNewWorkflowState(WorkflowState newWorkflowState) Sets the new workflow state of this form record and stores the old workflow state.voidsetNewWorkflowState(WorkflowState newWorkflowState, boolean forceUpdate) Sets the new workflow state of this form record and stores the old workflow state.voidsetParentId(Long parentId) voidsetParentVorgang(Vorgang parentVorgang) Deprecated.voidsetPassword(String password) voidsetProjekt(Projekt projekt) voidsetProzessId(String uuid) voidsetQuellserver(String quellserver) Deprecated.UseFormRecordSubmission.setSubmitServerBaseUrl(String)instead.voidsetSaved(boolean saved) voidsetStatusChangeRead(boolean statusChangeRead) Deprecated.voidsetSubject(String subject) voidsetSubmissions(List<FormRecordSubmission> submissions) voidSets the UUID of this form record.voidsetUUIDObject(UUID uuid) Sets the UUID of this form record.voidsetVerifyExpireDate(Date verifyExpireDate) voidsetVerifyLock(boolean lock) voidsetVerifyUUID(String verifyUUID) voidsetWorkflowVersion(WorkflowVersion workflowVersion) toString()Methods inherited from class AClientDependentEntity
getMandant, setMandantMethods inherited from class AbstractLockableEntity
entityHasChanged, getLockingVersion, setLockingVersionMethods 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 ICustomAttributeProviding
getCustomAttribute, getCustomAttributeAs, getCustomAttributeAs, getCustomAttributeBoolean, getCustomAttributeDouble, getCustomAttributeDouble, getCustomAttributeEnum, getCustomAttributeEnum, getCustomAttributeInt, getCustomAttributeInt, getCustomAttributeJsonArray, getCustomAttributeJsonObject, getCustomAttributeLong, getCustomAttributeLong, getCustomAttributeString, getCustomAttributeString, getCustomAttributeUuidMethods inherited from interface ICustomAttributesEntity
removeCustomAttribute, setCustomAttribute, setCustomAttributeBoolean, setCustomAttributeDouble, setCustomAttributeEnum, setCustomAttributeInt, setCustomAttributeJSONArray, setCustomAttributeJSONObject, setCustomAttributeLong, setCustomAttributeString, setCustomAttributeUuidMethods inherited from interface de.xima.cmn.dao.interfaces.IEntity
isPersisted
-
Field Details
-
ATTR_EINGANGSDATUM
- See Also:
-
ATTR_STATUS
- See Also:
-
ATTR_SUBJECT
- See Also:
-
ATTR_END_USER_SUBJECT
- See Also:
-
ATTR_POSTFACH
- See Also:
-
ATTR_PARENT_ID
- See Also:
-
ATTR_PROZESSID
- See Also:
-
ATTR_PROJEKT
- See Also:
-
ATTR_LAST_STATUS_CHANGE_DATE
Deprecated.The lastStatusChangeDate will be persisted in the lastFormRecordSubmission.- See Also:
-
ATTR_FORMVERSION
- See Also:
-
ATTR_IN_ARBEIT
- See Also:
-
ATTR_VERIFY_UUID
- See Also:
-
ATTR_VERIFY_EXPIREDATE
- See Also:
-
ATTR_VERIFY_LOCK
- See Also:
-
PASSWORD
- See Also:
-
ATTR_GELESEN
- See Also:
-
ATTR_IS_SAVED
- See Also:
-
ATTR_FEHLERANZAHL
- See Also:
-
ATTR_ATTACHMENTS
- See Also:
-
ATTR_SUBMISSIONS
- See Also:
-
ATTR_ACCESSES
- See Also:
-
ATTR_CHATS
- See Also:
-
ATTR_IDENTITY_TOKEN
- See Also:
-
ATTR_WORKFLOW_VERISON
- See Also:
-
ATTR_CURRENT_WORKFLOW_STATE
- See Also:
-
ATTR_WORKFLOW_VERSION
- See Also:
-
ATTR_UUID
- See Also:
-
ATTR_CURRENT_FORMEINGANG
Deprecated.the form record data belongs to asubmission. A form record has nsubmissions.- See Also:
-
ATTR_QUELLSERVER
Deprecated.UseFormRecordSubmission.ATTR_SUBMIT_SERVER_BASE_URLinstead.- See Also:
-
ATTR_QUELLSERVER_ID
Deprecated.UseFormRecordSubmission.ATTR_SUBMIT_FRONTEND_SERVER_IDinstead.- See Also:
-
ATTR_CREATOR_REF
Deprecated.user information of the creator is now stored in theinitial form record submission- See Also:
-
ATTR_ERSTELLER_REF
Deprecated.user information of the creator is now stored in theinitial form record submission- See Also:
-
ATTR_EDITOR_REF
Deprecated.user information of the last editor is now stored in thelast form record submission- See Also:
-
ATTR_BEARBEITER_REF
-
ATTR_CREATOR_DATA
Deprecated.user information of the creator is now stored in theinitial form record submission- See Also:
-
ATTR_EDITOR_DATA
Deprecated.user information of the last editor is now stored in thelast form record submission- See Also:
-
ATTR_CREATOR_PROFILE_UUID
Deprecated.user information of the creator is now stored in theinitial form record submission- See Also:
-
ATTR_EDITOR_PROFILE_UUID
Deprecated.user information of the last editor is now stored in thelast form record submission- See Also:
-
ATTR_STATUS_CHANGED_READ
-
COL_FORM_VERSION_ID
- See Also:
-
COL_WORKFLOW_VERSION
- See Also:
-
COL_PROJECT_ID
- See Also:
-
COL_STATUS_ID
- See Also:
-
COL_SUBJECT
- See Also:
-
COL_END_USER_SUBJECT
- See Also:
-
COL_END_USER_DETAILS
- See Also:
-
COL_DATE_CREATED
- See Also:
-
COL_UUID
- See Also:
-
COL_FORM_RECORD_BOX_ID
- See Also:
-
COL_FLAG_READ
- See Also:
-
COL_FLAG_IN_PROGRESS
- See Also:
-
COL_VERIFY_UUID
- See Also:
-
COL_VERIFY_EXPIREDATE
- See Also:
-
COL_VERIFY_LOCK
- See Also:
-
COL_PASSWORD
- See Also:
-
COL_SAVED
- See Also:
-
COL_COUNT_ERRORS
- See Also:
-
COL_IDENTITYTOKEN
- See Also:
-
COL_CURRENT_WORKFLOW_STATE
- See Also:
-
COL_PARENT_ID
- See Also:
-
COL_DATE_STATUS_CHANGED
Deprecated.The lastStatusChangeDate will be perssited in the lastFormRecordSubmission.- See Also:
-
COL_FORM_RECORD_DATA_ID
Deprecated.the form record data belongs to asubmission. A form record has nsubmissions.- See Also:
-
COL_SOURCE_SERVER_ID
Deprecated.UseFormRecordSubmission.getSubmitFrontendServerId()instead.- See Also:
-
COL_SOURCE_SERVER_NAME
Deprecated.UseFormRecordSubmission.getSubmitServerBaseUrl()instead.- See Also:
-
COL_USER_DATA_CREATOR
Deprecated.user information of the creator is now stored in theinitial form record submission- See Also:
-
COL_USER_DATA_EDITOR
Deprecated.user information of the last editor is now stored in thelast form record submission- See Also:
-
COL_USER_REF_CREATOR
Deprecated.user information of the creator is now stored in theinitial form record submission- See Also:
-
COL_USER_REF_EDITOR
Deprecated.user information of the last editor is now stored in thelast form record submission- See Also:
-
COL_USER_PROFILE_UUID_CREATOR
Deprecated.user information of the creator is now stored in theinitial form record submission- See Also:
-
COL_USER_PROFILE_UUID_EDITOR
Deprecated.user information of the last editor is now stored in thelast form record submission- See Also:
-
MAX_LENGTH_IDENTITY_TOKEN
public static final int MAX_LENGTH_IDENTITY_TOKEN- See Also:
-
CUSTOM_ATTR_DOI_INIT_WORKFLOW_NODE_ID
- See Also:
-
CUSTOM_ATTR_USER_PORTAL_UUID
- See Also:
-
ATTR_CHILDREN
-
ATTR_PARENT_VORGANG
-
ATTR_FORMEINGAENGE
-
-
Constructor Details
-
Vorgang
public Vorgang()
-
-
Method Details
-
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
-
getAccesses
- Returns:
- The
FormRecordAccesss for the form record ordered by the access granted date in descending order.
-
setAccesses
-
getFormVersion
-
setFormVersion
-
getWorkflowVersion
- Returns:
- The version of the workflow that is to be used for this form record. The active workflow version of a project may change, but a form record keeps the workflow version that was active when the form record was created.
-
setWorkflowVersion
- Parameters:
workflowVersion- The version of the workflow that is to be used for this form record. The active workflow version of a project may change, but a form record keeps the workflow version that was active when the form record was created.
-
getCurrentWorkflowState
-
setCurrentWorkflowState
Deprecated.For Hibernate only, in most cases you should usesetNewWorkflowState(WorkflowState).- Parameters:
currentWorkflowState- The current workflow state of this form record.
-
getSubject
-
setSubject
-
getCurrentStatus
Deprecated.Use thegetCurrentWorkflowState()together with the new workflow engine.- Returns:
- The current
Statusof this form record, as set by workflow processing or manually by the user.
-
setCurrentStatus
Deprecated.Use thesetCurrentWorkflowState(WorkflowState)together with the new workflow engine.- Parameters:
status- The currentStatusof this form record, as set by workflow processing or manually by the user.
-
getEndUserSubject
-
setEndUserSubject
-
getEndUserDetails
-
setEndUserDetails
-
getEingangsDatum
-
setEingangsDatum
Deprecated.For Hibernate only, in most cases you should usesetNewEingangsDatum(Date).- Parameters:
eingangsDatum- The new date when the form record was created.
-
getProzessId
-
setProzessId
-
getUUID
Gets the UUID of this form record. The UUID must be globally unique, among all projects and clients. The UUID is used to identify the form record in the system.- Specified by:
getUUIDin interfaceIUUIDEntity- Returns:
- The UUID of this form record.
-
setUUID
Sets the UUID of this form record. The UUID must be globally unique, among all projects and clients. The UUID is used to identify the form record in the system.- Specified by:
setUUIDin interfaceIUUIDEntity- Parameters:
uuid- The UUID of this form record.
-
getProjekt
- Specified by:
getProjektin interfaceIProjektDependent
-
getUUIDObject
Gets the UUID of this form record. The UUID must be globally unique, among all projects and clients. The UUID is used to identify the form record in the system.- Specified by:
getUUIDObjectin interfaceIUUIDEntity- Returns:
- The UUID of this form record.
-
setUUIDObject
Sets the UUID of this form record. The UUID must be globally unique, among all projects and clients. The UUID is used to identify the form record in the system.- Parameters:
uuid- The UUID of this form record.
-
getAttachments
-
setAttachments
-
getCurrentPostfach
-
setCurrentPostfach
-
isGelesen
public boolean isGelesen() -
setGelesen
public void setGelesen(boolean gelesen) -
isInArbeit
public boolean isInArbeit()- Returns:
- The
in progressflag.truewhen there is an active workflow execution for this form record,falseotherwise. This is a purely cosmetic flag without any business logic, meant for the UI only. In particular, setting this flag will not prevent multiple workflow executions for the same form record. New workflow engine: The new workflow engine locks the form record for exclusive access via a database lock, seeFormRecordLock.
-
setInArbeit
public void setInArbeit(boolean inArbeit) - Parameters:
inArbeit- Thein progressflag.truewhen there is an active workflow execution for this form record,falseotherwise. This is a purely cosmetic flag without any business logic, meant for the UI only. In particular, setting this flag will not prevent multiple workflow executions for the same form record. New workflow engine: The new workflow engine locks the form record for exclusive access via a database lock, seeFormRecordLock.
-
getVerifyUUID
-
setVerifyUUID
-
getVerifyExpireDate
-
setVerifyExpireDate
-
isSaved
public boolean isSaved() -
setSaved
public void setSaved(boolean saved) -
isUsesNewWorkflow
public boolean isUsesNewWorkflow() -
setProjekt
- Specified by:
setProjektin interfaceIProjektDependent
-
getFehlerAnzahl
public int getFehlerAnzahl() -
setFehlerAnzahl
public void setFehlerAnzahl(int fehlerAnzahl) -
getLastStatusChangeDate
-
setLastStatusChangeDate
Deprecated.For Hibernate only, in most cases you should usesetNewLastStatusChangeDate(Date).- Parameters:
lastStatusChangeDate- The new last status change date.
-
getCurrentFormeingang
-
setCurrentFormeingang
Deprecated. -
getParentId
-
setParentId
-
getCustomAttributes
Description copied from interface:ICustomAttributeProvidingGets 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:
getCustomAttributesin interfaceICustomAttributeProviding- Returns:
- The custom attributes.
-
setCustomAttributes
Description copied from interface:ICustomAttributesEntitySets 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:
setCustomAttributesin interfaceICustomAttributesEntity- Parameters:
customAttributes- The new custom attributes to set.
-
getDisplayName
-
getDisplayDetails
Returns the display name of this form record for endusers.- Returns:
- The display name of this form record. This may be the enduser subject or if that is empty, the display name of the project
-
getCustomData
A list of custom key-value pairs, similar togetCustomAttributes(). The difference is in how the data is stored in the database:- custom attributes have a max length for the key and value, and are meant for short pieces of data. Database queries can be made against the key and value.
- custom data do not have any restriction on the length of the value, but cannot be queried via SQL statements. Custom data are also stored encrypted in the database.
- Returns:
- A map of custom key-value pairs.
-
setCustomData
A list of custom key-value pairs, similar togetCustomAttributes(). The difference is in how the data is stored in the database:- custom attributes have a max length for the key and value, and are meant for short pieces of data. Database queries can be made against the key and value.
- custom data do not have any restriction on the length of the value, but cannot be queried via SQL statements. Custom data are also stored encrypted in the database.
- Parameters:
customData- A map of custom key-value pairs.
-
getIdentityToken
-
setIdentityToken
-
getNewStatus
Deprecated. -
setNewStatus
Deprecated. -
isLoeschbar
public boolean isLoeschbar()Vorgänge sind löschbar, wenn der Status, in dem sie sich befinden, das Löschen von Vorgängen erlaubt.- Returns:
true, wenn dieser Vorgang löschbar ist, ansonstenfalse.
-
isVerifyLock
public boolean isVerifyLock()- Returns:
- Whether this form record should be locked when a double opt-in is pending. When locked, the data of the form record cannot be accessed in the inbox.
-
setVerifyLock
public void setVerifyLock(boolean lock) - Parameters:
lock- Whether this form record should be locked when a double opt-in is pending. When locked, the data of the form record cannot be accessed in the inbox.
-
getPassword
-
setPassword
-
getInitialSubmission
-
getLastSubmission
-
getSubmissions
-
setSubmissions
-
getCreatorRef
-
setCreatorRef
Deprecated.UsegetInitialSubmission()instead.- See Also:
-
getEditorRef
-
setEditorRef
Deprecated.UsegetLastSubmission()instead.- See Also:
-
getCreatorData
public com.alibaba.fastjson.JSONObject getCreatorData() -
setCreatorData
Deprecated.UsegetInitialSubmission()instead.- See Also:
-
getEditorData
public com.alibaba.fastjson.JSONObject getEditorData() -
setEditorData
Deprecated.UsegetLastSubmission()instead.- See Also:
-
getChats
-
setChats
-
getUnreadChatCount
Returns the number of unread chat messages for the given user.- Parameters:
user- The user for which to get the number of unread chat messages.- Returns:
- The number of unread chats for the given user.
-
getUnreadChatCount
Returns the number of unread chats for the given user.- Parameters:
user- The user for which to get the number of unread chats.- Returns:
- The number of unread chats for the given user.
-
getUnreadMessageCount
Returns the number of unread chat messages for the given user.- Parameters:
user- The user for which to get the number of unread chat messages.- Returns:
- The number of unread chats for the given user.
-
getUnreadMessageCount
Returns the number of unread chat messages for the given user.- Parameters:
user- The user for which to get the number of unread chat messages.- Returns:
- The number of unread chats for the given user.
-
getOldWorkflowState
- Returns:
- The old workflow state from before a state change took place. This is a transient field and only available temporarily while the entity is updated.
-
isHasWorkflowStateChanged
public boolean isHasWorkflowStateChanged()- Returns:
- Whether the workflow state was changed. This is a transient field and only available temporarily while the entity is updated.
-
isHasDateChanged
public boolean isHasDateChanged()- Returns:
- Whether any of the date fields were changed. This is a transient field and only available temporarily while the entity is updated.
-
getParentVorgang
Deprecated.usegetParentId() -
setParentVorgang
Deprecated. -
getChildren
Deprecated.Can be extremely slow !!! Use query withATTR_PARENT_IDas filter -
setChildren
Deprecated.Can be extremely slow !!! Use query withATTR_PARENT_IDas filter -
getFormeingaenge
Deprecated. -
setFormeingaenge
Deprecated. -
getFrontendserver_id
Deprecated.UseFormRecordSubmission.getSubmitFrontendServerId()instead.Getter für quellserver_id- Returns:
Longdes quellserver_id- See Also:
-
setFrontendserver_id
Deprecated.Setter des quellserver_id- Parameters:
quellserver_id-Longder zu setzende quellserver_id- See Also:
-
getQuellserver
Deprecated.UseFormRecordSubmission.getSubmitServerBaseUrl()instead.Der Verbindungsname desFrontendServerwelche den Vorgang zuletzt bearbeitet hat- Returns:
Stringdes bearbeitungsquelle- See Also:
-
setQuellserver
Deprecated.UseFormRecordSubmission.setSubmitServerBaseUrl(String)instead.- Parameters:
quellserver-Stringder zu setzende Quellserver- See Also:
-
getCreatorProfileUuid
-
setCreatorProfileUuid
Deprecated.Does nothing.- See Also:
-
getEditorProfileUuid
-
setEditorProfileUuid
Deprecated.Does nothing.- See Also:
-
getBearbeiter
-
setBearbeiter
Deprecated. -
getErsteller
Deprecated. -
setErsteller
Deprecated. -
getErstellerRef
Deprecated. -
setErstellerRef
Deprecated. -
getBearbeiterRef
Deprecated. -
setBearbeiterRef
Deprecated. -
isStatusChangeRead
Deprecated. -
setStatusChangeRead
Deprecated. -
setNewWorkflowState
Sets the new workflow state of this form record and stores the old workflow state.- Parameters:
newWorkflowState- The new workflow state for this form record.
-
setNewEingangsDatum
Sets the new date when the form record was created and stores the info whether it was changed.- Parameters:
newEingangsDatum- The new date when the form record was created.
-
setNewLastStatusChangeDate
Sets the new date when the last status changed occurred and stores the info whether it was changed.- Parameters:
newLastStatusChangeDate- The new last status change date.
-
setFormData
-
setCreator
Deprecated.- See Also:
-
setEditor
Deprecated.- See Also:
-
setCreator
Deprecated.UsesetCreator(IUser)instead. -
setEditor
Deprecated.UsesetEditor(IUser)instead. -
setNewWorkflowState
Sets the new workflow state of this form record and stores the old workflow state.- Parameters:
newWorkflowState- The new workflow state for this form record.forceUpdate- Whentrue, the state is marked as having changed even when the given state equals the current state.
-
addAttachment
-
removeAttachment
-
addSubmission
@Deprecated public void addSubmission(IUser user, EFormRecordSubmitContext submitContext, @Nullable FrontendServer submitFrontendServer, String submitServerBaseUrl, String formData, boolean newDataEntry) Deprecated.Adds a new submission to the form record.- Parameters:
user- The user that submitted the form record.submitContext- The context in which the form record was submitted.submitFrontendServer- The frontend server that received the submission.submitServerBaseUrl- The base URL of the server that received the submission.formData- The data of the submission.newDataEntry- Whether this submission should be stored as a new data entry.
-
addSubmission
public void addSubmission(IUser user, EFormRecordSubmitContext submitContext, @Nullable FrontendServer submitFrontendServer, String submitServerBaseUrl, Locale submitLocale, String formData, boolean newDataEntry) Adds a new submission to the form record.- Parameters:
user- The user that submitted the form record.submitContext- The context in which the form record was submitted.submitFrontendServer- The frontend server that received the submission.submitServerBaseUrl- The base URL of the server that received the submission.formData- The data of the submission.newDataEntry- Whether this submission should be stored as a new data entry.
-
toString
- Overrides:
toStringin classAbstractLockableEntity
-
clearOldWorkflowState
public void clearOldWorkflowState() -
addChild
Deprecated. -
removeChild
Deprecated. -
addFormeingang
Deprecated. -
removeFormeingang
Deprecated. -
getCreatorDataString
Deprecated.UsegetInitialSubmission()instead.- See Also:
-
setCreatorDataString
Deprecated.UsegetInitialSubmission()instead.- See Also:
-
getEditorDataString
Deprecated.UsegetLastSubmission()instead.- See Also:
-
setEditorDataString
Deprecated.UsegetInitialSubmission()instead.- See Also:
-
initial form record submission