Package com.flowable.core.service.form

Class FlowableFormFieldHandler

java.lang.Object

com.flowable.core.service.form.FlowableFormFieldHandler

All Implemented Interfaces:

FormFieldHandler

public class FlowableFormFieldHandler
extends Object
implements FormFieldHandler

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	FlowableFormFieldHandler.CustomFolderPath
static class	FlowableFormFieldHandler.ScopeFolderPath

Field Summary

Fields

Modifier and Type	Field	Description
protected static final String	AUTOUPLOAD
protected static final String	COLS
protected static final String	CUSTOM_FOLDER_PATH
protected boolean	enableLegacyOutcomeVisibility
protected static final String	EXTRA_SETTINGS
protected FolderNameParser	folderNameParser
protected static final String	LAYOUT_DEFINITION
protected static final String	PATH_SEPARATOR
protected static final String	ROWS
protected static final String	SECTIONS
protected static final String	TYPE

Constructor Summary

Constructors

Constructor	Description
FlowableFormFieldHandler(FolderNameParser folderNameParser, boolean enableLegacyOutcomeVisibility)

Method Summary

Modifier and Type	Method	Description
protected CoreContentItem	createParentFolderHierarchy(String scopeId, String scopeType, String tenantId, FlowableFormFieldHandler.ScopeFolderPath folderPath, CoreContentService contentService, Map<String,CoreContentItem> createdFolderMap)
void	enrichFormFields(FormInfo formInfo)
protected CaseInstance	fetchCaseInstance(String caseInstanceId)
protected ProcessInstance	fetchProcessInstance(String processInstanceId)
protected void	fillContentItemInfo(CoreContentItem contentItem, String taskId, String processInstanceId, String scopeId, String scopeType, String tenantId, Map<String,CoreContentItem> createdFolderMap, CoreContentService contentService)
protected void	fillDocumentDefinition(String documentDefinitionRef, CoreContentItem platformContentItem, CoreContentEngineConfigurationApi contentEngineConfiguration)
protected boolean	formHasEditableAttachmentField(FormInfo formInfo)
protected FlowableFormFieldHandler.ScopeFolderPath	getCaseCustomFolderPath(String caseInstanceId, CaseInstance caseInstance, CaseDefinition caseDefinition)
protected FlowableFormFieldHandler.ScopeFolderPath	getCaseTaskCustomFolderPath(Task task, String taskDefinitionKey, String caseDefinitionId, String scopeId)
protected CmmnEngineConfiguration	getCmmnEngineConfiguration()
protected String	getCmmnExtensionElementValue(String name, Map<String,List<ExtensionElement>> extensionElements)
protected CmmnRepositoryService	getCmmnRepositoryService()
protected CmmnRuntimeService	getCmmnRuntimeService()
protected FlowableFormFieldHandler.ScopeFolderPath	getCustomFolderPathForParentEntityLink(EntityLink parentEntityLink)
protected EntityLinkService	getEntityLinkService()
protected String	getExtensionElementValue(String name, Map<String,List<ExtensionElement>> extensionElements)
protected Map<String,Object>	getExtraSettings(Map<String,Object> formField)
protected CoreContentItem	getFolderContentItem(String scopeId, String scopeType, String tenantId, CoreContentService contentService, Map<String,CoreContentItem> createdFolderMap)
protected FlowableFormFieldHandler.ScopeFolderPath	getFolderNameForScope(String scopeId, String scopeType)
protected List<Map<String,Object>>	getListObjectByName(String name, Map<String,Object> formField)
protected Map<String,Object>	getMapObjectByName(String name, Map<String,Object> formField)
protected String	getOrCreateParentFolder(CoreContentItem contentItem, CoreContentService contentService, Map<String,CoreContentItem> cachedFolders)
protected String	getOrCreateParentFolderFromHierarchy(String scopeId, String scopeType, String tenantId, FlowableFormFieldHandler.ScopeFolderPath folderPath, CoreContentService contentService, Map<String,CoreContentItem> createdFolderMap)
protected String	getOrCreateRootFolderId(String tenantId, CoreContentService contentService, Map<String,CoreContentItem> createdFolderMap)
protected String	getOrCreateWorkFolderId(String tenantId, CoreContentService contentService, Map<String,CoreContentItem> createdFolderMap)
protected EntityLink	getParentEntityLink(String scopeId, String scopeType)
protected FlowableFormFieldHandler.ScopeFolderPath	getProcessCustomFolderPath(String processInstanceId, ProcessInstance processInstance, ProcessDefinition processDefinition)
protected ProcessEngineConfiguration	getProcessEngineConfiguration()
protected FlowableFormFieldHandler.ScopeFolderPath	getProcessTaskCustomFolderPath(Task task, String taskDefinitionKey, String processDefinitionId, String processInstanceId)
protected RepositoryService	getRepositoryService()
protected RuntimeService	getRuntimeService()
protected FlowableFormFieldHandler.ScopeFolderPath	getTaskCustomFolderPath(Task task)
protected TaskService	getTaskService()
protected CoreContentItem	getWorkFolder(String tenantId, CoreContentService contentService, Map<String,CoreContentItem> createdFolderMap)
protected void	handleContentItemJson(com.fasterxml.jackson.databind.JsonNode childNode, Map<String,CoreContentItem> createdFolderMap, String taskId, String processInstanceId, String scopeId, String scopeType, Map<String,Object> variables, String tenantId, CoreContentService contentService, CoreContentEngineConfigurationApi contentEngineConfiguration)
protected void	handleFormFieldJson(com.fasterxml.jackson.databind.JsonNode jsonNode, Map<String,CoreContentItem> createdFolderMap, String taskId, String processInstanceId, String scopeId, String scopeType, Map<String,Object> variables, String tenantId, CoreContentService contentService, CoreContentEngineConfigurationApi contentEngineConfiguration)
void	handleFormFieldsOnSubmit(FormInfo formInfo, String taskId, String processInstanceId, String scopeId, String scopeType, Map<String,Object> variables, String tenantId)
protected void	internalHandleContentItem(CoreContentItem contentItem, String taskId, String processInstanceId, String scopeId, String scopeType, String tenantId, Map<String,CoreContentItem> createdFolderMap, ContentService contentService, CoreContentEngineConfigurationApi contentEngineConfiguration)
protected void	internalHandleContentItemWithMetadataJson(CoreContentItem contentItem, com.fasterxml.jackson.databind.JsonNode metadataProperties, String taskId, String processInstanceId, String scopeId, String scopeType, String tenantId, Map<String,CoreContentItem> createdFolderMap, ContentService contentService, CoreContentEngineConfigurationApi contentEngineConfiguration)
boolean	isWorkFolder(CoreContentItem contentItem)
protected boolean	lookForAttachmentFields(Map<String,Object> formField)
protected boolean	lookForAttachmentFieldsInExtraSettingsMap(Map<String,Object> extraSettings)
protected void	processExtraSettingsMap(Map<String,Object> extraSettings)
protected void	processFormFieldMap(Map<String,Object> formField)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

EXTRA_SETTINGS

protected static final String EXTRA_SETTINGS

See Also:

• Constant Field Values

LAYOUT_DEFINITION

protected static final String LAYOUT_DEFINITION

See Also:

• Constant Field Values

SECTIONS

protected static final String SECTIONS

See Also:

• Constant Field Values

ROWS

protected static final String ROWS

See Also:

• Constant Field Values

COLS

protected static final String COLS

See Also:

• Constant Field Values

TYPE

protected static final String TYPE

See Also:

• Constant Field Values

AUTOUPLOAD

protected static final String AUTOUPLOAD

See Also:

• Constant Field Values

CUSTOM_FOLDER_PATH

protected static final String CUSTOM_FOLDER_PATH

See Also:

• Constant Field Values

PATH_SEPARATOR

protected static final String PATH_SEPARATOR

See Also:

• Constant Field Values

folderNameParser

protected FolderNameParser folderNameParser

enableLegacyOutcomeVisibility

protected boolean enableLegacyOutcomeVisibility

Constructor Details

FlowableFormFieldHandler

public FlowableFormFieldHandler(FolderNameParser folderNameParser,
 boolean enableLegacyOutcomeVisibility)

Method Details

handleFormFieldsOnSubmit

public void handleFormFieldsOnSubmit(FormInfo formInfo,
 String taskId,
 String processInstanceId,
 String scopeId,
 String scopeType,
 Map<String,Object> variables,
 String tenantId)

Specified by:

handleFormFieldsOnSubmit in interface FormFieldHandler

handleFormFieldJson

protected void handleFormFieldJson(com.fasterxml.jackson.databind.JsonNode jsonNode,
 Map<String,CoreContentItem> createdFolderMap,
 String taskId,
 String processInstanceId,
 String scopeId,
 String scopeType,
 Map<String,Object> variables,
 String tenantId,
 CoreContentService contentService,
 CoreContentEngineConfigurationApi contentEngineConfiguration)

handleContentItemJson

protected void handleContentItemJson(com.fasterxml.jackson.databind.JsonNode childNode,
 Map<String,CoreContentItem> createdFolderMap,
 String taskId,
 String processInstanceId,
 String scopeId,
 String scopeType,
 Map<String,Object> variables,
 String tenantId,
 CoreContentService contentService,
 CoreContentEngineConfigurationApi contentEngineConfiguration)

internalHandleContentItem

protected void internalHandleContentItem(CoreContentItem contentItem,
 String taskId,
 String processInstanceId,
 String scopeId,
 String scopeType,
 String tenantId,
 Map<String,CoreContentItem> createdFolderMap,
 ContentService contentService,
 CoreContentEngineConfigurationApi contentEngineConfiguration)

internalHandleContentItemWithMetadataJson

protected void internalHandleContentItemWithMetadataJson(CoreContentItem contentItem,
 com.fasterxml.jackson.databind.JsonNode metadataProperties,
 String taskId,
 String processInstanceId,
 String scopeId,
 String scopeType,
 String tenantId,
 Map<String,CoreContentItem> createdFolderMap,
 ContentService contentService,
 CoreContentEngineConfigurationApi contentEngineConfiguration)

enrichFormFields

public void enrichFormFields(FormInfo formInfo)

Specified by:

enrichFormFields in interface FormFieldHandler

fillContentItemInfo

protected void fillContentItemInfo(CoreContentItem contentItem,
 String taskId,
 String processInstanceId,
 String scopeId,
 String scopeType,
 String tenantId,
 Map<String,CoreContentItem> createdFolderMap,
 CoreContentService contentService)

getOrCreateParentFolder

protected String getOrCreateParentFolder(CoreContentItem contentItem,
 CoreContentService contentService,
 Map<String,CoreContentItem> cachedFolders)

getOrCreateParentFolderFromHierarchy

protected String getOrCreateParentFolderFromHierarchy(String scopeId,
 String scopeType,
 String tenantId,
 FlowableFormFieldHandler.ScopeFolderPath folderPath,
 CoreContentService contentService,
 Map<String,CoreContentItem> createdFolderMap)

getFolderContentItem

protected CoreContentItem getFolderContentItem(String scopeId,
 String scopeType,
 String tenantId,
 CoreContentService contentService,
 Map<String,CoreContentItem> createdFolderMap)

createParentFolderHierarchy

protected CoreContentItem createParentFolderHierarchy(String scopeId,
 String scopeType,
 String tenantId,
 FlowableFormFieldHandler.ScopeFolderPath folderPath,
 CoreContentService contentService,
 Map<String,CoreContentItem> createdFolderMap)

fillDocumentDefinition

protected void fillDocumentDefinition(String documentDefinitionRef,
 CoreContentItem platformContentItem,
 CoreContentEngineConfigurationApi contentEngineConfiguration)

formHasEditableAttachmentField

protected boolean formHasEditableAttachmentField(FormInfo formInfo)

getParentEntityLink

protected EntityLink getParentEntityLink(String scopeId,
 String scopeType)

getFolderNameForScope

protected FlowableFormFieldHandler.ScopeFolderPath getFolderNameForScope(String scopeId,
 String scopeType)

getCaseCustomFolderPath

protected FlowableFormFieldHandler.ScopeFolderPath getCaseCustomFolderPath(String caseInstanceId,
 CaseInstance caseInstance,
 CaseDefinition caseDefinition)

getProcessCustomFolderPath

protected FlowableFormFieldHandler.ScopeFolderPath getProcessCustomFolderPath(String processInstanceId,
 ProcessInstance processInstance,
 ProcessDefinition processDefinition)

getTaskCustomFolderPath

protected FlowableFormFieldHandler.ScopeFolderPath getTaskCustomFolderPath(Task task)

getProcessTaskCustomFolderPath

protected FlowableFormFieldHandler.ScopeFolderPath getProcessTaskCustomFolderPath(Task task,
 String taskDefinitionKey,
 String processDefinitionId,
 String processInstanceId)

getCaseTaskCustomFolderPath

protected FlowableFormFieldHandler.ScopeFolderPath getCaseTaskCustomFolderPath(Task task,
 String taskDefinitionKey,
 String caseDefinitionId,
 String scopeId)

getCustomFolderPathForParentEntityLink

protected FlowableFormFieldHandler.ScopeFolderPath getCustomFolderPathForParentEntityLink(EntityLink parentEntityLink)

fetchCaseInstance

protected CaseInstance fetchCaseInstance(String caseInstanceId)

fetchProcessInstance

protected ProcessInstance fetchProcessInstance(String processInstanceId)

getWorkFolder

protected CoreContentItem getWorkFolder(String tenantId,
 CoreContentService contentService,
 Map<String,CoreContentItem> createdFolderMap)

getOrCreateWorkFolderId

protected String getOrCreateWorkFolderId(String tenantId,
 CoreContentService contentService,
 Map<String,CoreContentItem> createdFolderMap)

getOrCreateRootFolderId

protected String getOrCreateRootFolderId(String tenantId,
 CoreContentService contentService,
 Map<String,CoreContentItem> createdFolderMap)

lookForAttachmentFields

protected boolean lookForAttachmentFields(Map<String,Object> formField)

lookForAttachmentFieldsInExtraSettingsMap

protected boolean lookForAttachmentFieldsInExtraSettingsMap(Map<String,Object> extraSettings)

processFormFieldMap

protected void processFormFieldMap(Map<String,Object> formField)

processExtraSettingsMap

protected void processExtraSettingsMap(Map<String,Object> extraSettings)

getCmmnExtensionElementValue

protected String getCmmnExtensionElementValue(String name,
 Map<String,List<ExtensionElement>> extensionElements)

getExtensionElementValue

protected String getExtensionElementValue(String name,
 Map<String,List<ExtensionElement>> extensionElements)

getExtraSettings

protected Map<String,Object> getExtraSettings(Map<String,Object> formField)

getMapObjectByName

protected Map<String,Object> getMapObjectByName(String name,
 Map<String,Object> formField)

getListObjectByName

protected List<Map<String,Object>> getListObjectByName(String name,
 Map<String,Object> formField)

isWorkFolder

public boolean isWorkFolder(CoreContentItem contentItem)

getRuntimeService

protected RuntimeService getRuntimeService()

getCmmnRuntimeService

protected CmmnRuntimeService getCmmnRuntimeService()

getRepositoryService

protected RepositoryService getRepositoryService()

getCmmnRepositoryService

protected CmmnRepositoryService getCmmnRepositoryService()

getEntityLinkService

protected EntityLinkService getEntityLinkService()

getTaskService

protected TaskService getTaskService()

getProcessEngineConfiguration

protected ProcessEngineConfiguration getProcessEngineConfiguration()

getCmmnEngineConfiguration

protected CmmnEngineConfiguration getCmmnEngineConfiguration()