Package com.flowable.platform.service.process

Class BpmnFormProvider

java.lang.Object

com.flowable.platform.service.form.PermissionAwareFormProvider

com.flowable.platform.service.process.BpmnFormProvider

All Implemented Interfaces:

FormProvider, PermissionServiceRegistryAware, Aware

public class BpmnFormProvider
extends PermissionAwareFormProvider

Author:

Filip Hrisafov

Field Summary

Fields

Modifier and Type	Field	Description
protected final FormRepositoryService	formRepositoryService
protected final FormService	formService
protected final ProcessEngine	processEngine

Fields inherited from class com.flowable.platform.service.form.PermissionAwareFormProvider

permissionServiceRegistry

Constructor Summary

Constructors

Constructor	Description
BpmnFormProvider(ProcessEngine processEngine, FormRepositoryService formRepositoryService, FormService formService)

Method Summary

Modifier and Type	Method	Description
protected ProcessInstanceInfo	fetchProcessInstanceWithHistory(String processInstanceId)
protected String	getExtensionElementText(BaseElement baseElement, String extensionElementName)
FormInfo	getFormInfoForScopeDefinitionId(String scopeDefinitionId, FormProviderContext context)	Retrieve the form info for the given scopeDefinitionId in the provided context.
FormInfo	getFormInfoForScopeId(String scopeId, FormProviderContext context)	Retrieve the form info for the given scopeId in the provided context
protected HistoryService	getHistoryService()
protected RepositoryService	getRepositoryService()
protected RuntimeService	getRuntimeService()
String	getScopeType()	The scope type that this form provider is responsible for
protected FormInfo	getStartFormInfo(String processInstanceId)
protected FormInfo	getStartFormInfoByDefinitionId(String scopeDefinitionId)
protected FormInfo	getWorkFormInfo(String processInstanceId)

Methods inherited from class com.flowable.platform.service.form.PermissionAwareFormProvider

getCurrentTenantId, getPermissionScopeType, setPermissionServiceRegistry, validatePermissionOnHistoricScope, validatePermissionOnRuntimeScope, validatePermissionOnScope, validateReadPermissionOnScopeDefinition

Methods inherited from class java.lang.Object

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

Field Details

processEngine

protected final ProcessEngine processEngine

formRepositoryService

protected final FormRepositoryService formRepositoryService

formService

protected final FormService formService

Constructor Details

BpmnFormProvider

public BpmnFormProvider(ProcessEngine processEngine,
 FormRepositoryService formRepositoryService,
 FormService formService)

Method Details

getScopeType

public String getScopeType()

Description copied from interface: FormProvider

The scope type that this form provider is responsible for

getFormInfoForScopeId

public FormInfo getFormInfoForScopeId(String scopeId,
 FormProviderContext context)

Description copied from interface: FormProvider

Retrieve the form info for the given scopeId in the provided context

Parameters:

scopeId - the scope instance id

context - the context under which the form info should be retrieved (never null)

Returns:

the form info for the scope

getStartFormInfo

protected FormInfo getStartFormInfo(String processInstanceId)

getWorkFormInfo

protected FormInfo getWorkFormInfo(String processInstanceId)

fetchProcessInstanceWithHistory

protected ProcessInstanceInfo fetchProcessInstanceWithHistory(String processInstanceId)

getExtensionElementText

protected String getExtensionElementText(BaseElement baseElement,
 String extensionElementName)

getFormInfoForScopeDefinitionId

public FormInfo getFormInfoForScopeDefinitionId(String scopeDefinitionId,
 FormProviderContext context)

Description copied from interface: FormProvider

Retrieve the form info for the given scopeDefinitionId in the provided context. This is different compared with FormProvider.getFormInfoForScopeId(String, FormProviderContext) such that it looks for a form for a given definition instead of an instance.

Parameters:

scopeDefinitionId - the scope definition id

context - the context under which the form info should be retrieved (never null)

Returns:

the form info for the scope definition

getStartFormInfoByDefinitionId

protected FormInfo getStartFormInfoByDefinitionId(String scopeDefinitionId)

getHistoryService

protected HistoryService getHistoryService()

getRuntimeService

protected RuntimeService getRuntimeService()

getRepositoryService

protected RepositoryService getRepositoryService()