Package com.flowable.platform.service.process

Class PlatformProcessInstanceService

java.lang.Object

com.flowable.platform.security.service.AbstractPlatformSecurityService

com.flowable.platform.service.process.PlatformProcessInstanceService

All Implemented Interfaces:

com.flowable.platform.security.permission.PermissionServiceRegistryAware, org.springframework.beans.factory.Aware

@Transactional
public class PlatformProcessInstanceService
extends com.flowable.platform.security.service.AbstractPlatformSecurityService

Author:

Yvo Swillens

Field Summary

Fields

Modifier and Type	Field	Description
protected AuditService	auditService
protected org.flowable.cmmn.api.CmmnHistoryService	cmmnHistoryService
protected com.flowable.core.content.api.CoreContentService	contentService
protected DocumentMetadataHandler	documentMetadataHandler
protected com.flowable.core.content.api.DocumentRepositoryService	documentRepositoryService
protected boolean	enableAuditLog
protected org.flowable.spring.SpringProcessEngineConfiguration	engineConfiguration
protected com.flowable.core.service.form.FlowableFormDecoratorInvoker	formDecoratorInvoker
protected org.flowable.form.api.FormRepositoryService	formRepositoryService
protected org.flowable.form.api.FormService	formService
protected org.flowable.engine.HistoryService	historyService
protected org.springframework.beans.factory.ObjectProvider<InspectProcessInstanceInterceptor>	inspectProcessInstanceInterceptor
protected com.flowable.core.content.api.MetadataService	metadataService
protected com.fasterxml.jackson.databind.ObjectMapper	objectMapper
protected PlatformCommentService	platformCommentService
protected PlatformContentItemPermissionHandler	platformContentItemPermissionHandler
protected PlatformContentItemService	platformContentItemService
protected PlatformTranslationService	platformTranslationService
protected com.flowable.platform.security.permission.ProcessPermissionService	processPermissionService
protected PlatformRestVariableTransformer	variableTransformer

Fields inherited from class com.flowable.platform.security.service.AbstractPlatformSecurityService

additionalAdminUsers, CASE_PREFIX, cmmnRepositoryService, cmmnRuntimeService, cmmnTaskService, defaultSecurityPolicyKey, defaultSecurityPolicyModel, inspectEnabled, permissionServiceRegistry, platformSecurityInterceptor, policyRepositoryService, PROCESS_PREFIX, repositoryService, runtimeService, SECURITY_POLICY_MODEL, TASK_PREFIX, taskService

Constructor Summary

Constructors

Constructor	Description
PlatformProcessInstanceService(boolean enableAuditLog)

Method Summary

Modifier and Type	Method	Description
protected void	addTranslations(ProcessInstanceRepresentation processInstanceRepresentation, org.flowable.engine.repository.ProcessDefinition processDefinition)
void	assign(java.lang.String processInstanceId, java.lang.String userId)
CommentInstanceRepresentation	createProcessInstanceComment(java.lang.String processInstanceId, java.lang.String commentContent)
void	deleteProcessInstanceComment(java.lang.String processInstanceId, java.lang.String commentId)
protected org.flowable.engine.runtime.ProcessInstance	fetchProcessInstance(java.lang.String processInstanceId)
protected ProcessInstanceInfo	fetchProcessInstanceWithHistory(java.lang.String processInstanceId)
org.flowable.content.api.ContentItem	getContentItem(java.lang.String processInstanceId, java.lang.String contentItemId)
protected java.lang.String	getExtensionElementText(org.flowable.bpmn.model.BaseElement baseElement, java.lang.String extensionElementName)
protected org.flowable.form.api.FormInfo	getFormInfo(java.lang.String processInstanceId, java.lang.String deploymentId, java.lang.String processDefinitionId, java.lang.String tenantId)
protected java.util.Map<java.lang.String,java.lang.Object>	getHistoricVariables(java.lang.String processInstanceId)
ProcessInstanceRepresentation	getProcessInstance(java.lang.String processInstanceId, boolean includeTranslations)
org.flowable.common.rest.api.DataResponse<CommentInstanceRepresentation>	getProcessInstanceComments(CommentQueryRequest request)
protected java.util.Map<java.lang.String,java.lang.Object>	getProcessVariables(java.lang.String processInstanceId)
org.flowable.form.api.FormInfo	getStartFormForProcessInstanceId(java.lang.String processInstanceId)
java.util.Map<java.lang.String,java.lang.Object>	getStartFormVariablesByProcessInstanceId(java.lang.String processInstanceId)
protected java.util.Map<java.lang.String,java.lang.Object>	getStartFormVariablesByProcessInstanceIdWithoutPermissionCheck(java.lang.String processInstanceId)
java.util.Map<java.lang.String,java.lang.Object>	getVariablesByProcessInstanceId(java.lang.String processInstanceId, java.lang.String subScopeId)
java.util.Map<java.lang.String,java.lang.Object>	getVariablesByProcessInstanceIdWithPermissionCheck(java.lang.String processInstanceId, java.lang.String subScopeId)
org.flowable.form.api.FormInfo	getWorkFormForProcessInstanceId(java.lang.String processInstanceId)
protected java.lang.String	getWorkFormValidationExpression(java.lang.String processDefinitionId)
protected boolean	isFormFieldValidationEnabled(org.flowable.common.engine.api.variable.VariableContainer variableContainer, java.lang.String workFormValidationExpression)
protected void	logSaveProcessEvent(org.flowable.engine.runtime.ProcessInstance processInstance)
void	saveDocuments(java.lang.String processInstanceId, java.util.Map<java.lang.String,java.lang.Object> variables)
void	saveWorkForm(java.lang.String processInstanceId, java.util.Map<java.lang.String,java.lang.Object> variables)
ProcessInstanceRepresentation	startNewProcessInstance(CreateProcessInstanceRepresentation startRequest, boolean includeTranslations, boolean createTestDefinition)
protected void	transformVariables(java.util.Map<java.lang.String,java.lang.Object> variables)
CommentInstanceRepresentation	updateProcessInstanceComment(java.lang.String processInstanceId, java.lang.String commentId, java.lang.String commentContent)

Methods inherited from class com.flowable.platform.security.service.AbstractPlatformSecurityService

currentUserHasAdminRights, currentUserIsSuperAdmin, fetchCasePermissionMappings, fetchCasePermissionMappings, fetchCaseSecurityPolicyModel, fetchPermissions, fetchPermissionsForTask, fetchProcessPermissionMappings, fetchProcessPermissionMappings, fetchProcessSecurityPolicyModel, fetchSecurityPolicyModel, fetchSecurityPolicyModel, fetchSecurityPolicyModelForCaseInstance, fetchSecurityPolicyModelForProcessInstance, fetchSecurityPolicyModelForTask, fetchSecurityPolicyModelForTask, fetchTaskPermissionMappings, fetchTaskPermissionMappings, fetchTaskPermissionMappings, fetchTaskPermissionMappingsForCase, fetchTaskPermissionMappingsForProcess, fetchTaskSecurityPolicyModelForCase, fetchTaskSecurityPolicyModelForProcess, filterPermissionsForRole, getCmmnExtensionElementValue, getCurrentGroupKeys, getCurrentTenantId, getCurrentUserId, getDefaultSecurityPolicyModel, getExtensionElementValue, getSecurityPolicyModelByKey, groupOrUserMatches, groupOrUserMatches, hasAnyMatchingIdentityLink, hasAssigneeOrOwnerIdentityLink, hasPermissionForEntityLinks, hasPermissionForHistoricEntityLinks, setPermissionServiceRegistry, translatePermissionForScope

Methods inherited from class java.lang.Object

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

Field Detail

enableAuditLog

protected final boolean enableAuditLog

processPermissionService

@Autowired
protected com.flowable.platform.security.permission.ProcessPermissionService processPermissionService

historyService

@Autowired
protected org.flowable.engine.HistoryService historyService

cmmnHistoryService

@Autowired
protected org.flowable.cmmn.api.CmmnHistoryService cmmnHistoryService

formService

@Autowired
protected org.flowable.form.api.FormService formService

formRepositoryService

@Autowired
protected org.flowable.form.api.FormRepositoryService formRepositoryService

platformTranslationService

@Autowired(required=false)
protected PlatformTranslationService platformTranslationService

platformCommentService

@Autowired(required=false)
protected PlatformCommentService platformCommentService

auditService

@Autowired(required=false)
protected AuditService auditService

platformContentItemService

@Autowired(required=false)
protected PlatformContentItemService platformContentItemService

contentService

@Autowired(required=false)
protected com.flowable.core.content.api.CoreContentService contentService

metadataService

@Autowired(required=false)
protected com.flowable.core.content.api.MetadataService metadataService

documentRepositoryService

@Autowired(required=false)
protected com.flowable.core.content.api.DocumentRepositoryService documentRepositoryService

documentMetadataHandler

@Autowired(required=false)
protected DocumentMetadataHandler documentMetadataHandler

platformContentItemPermissionHandler

@Autowired(required=false)
protected PlatformContentItemPermissionHandler platformContentItemPermissionHandler

inspectProcessInstanceInterceptor

@Autowired
protected org.springframework.beans.factory.ObjectProvider<InspectProcessInstanceInterceptor> inspectProcessInstanceInterceptor

variableTransformer

@Autowired
protected PlatformRestVariableTransformer variableTransformer

engineConfiguration

@Autowired
protected org.flowable.spring.SpringProcessEngineConfiguration engineConfiguration

objectMapper

@Autowired
protected com.fasterxml.jackson.databind.ObjectMapper objectMapper

formDecoratorInvoker

@Autowired
protected com.flowable.core.service.form.FlowableFormDecoratorInvoker formDecoratorInvoker

Constructor Detail

PlatformProcessInstanceService

public PlatformProcessInstanceService(boolean enableAuditLog)

Method Detail

getProcessInstance

public ProcessInstanceRepresentation getProcessInstance(java.lang.String processInstanceId,
                                                        boolean includeTranslations)

addTranslations

protected void addTranslations(ProcessInstanceRepresentation processInstanceRepresentation,
                               org.flowable.engine.repository.ProcessDefinition processDefinition)

getStartFormVariablesByProcessInstanceId

public java.util.Map<java.lang.String,java.lang.Object> getStartFormVariablesByProcessInstanceId(java.lang.String processInstanceId)

getStartFormVariablesByProcessInstanceIdWithoutPermissionCheck

protected java.util.Map<java.lang.String,java.lang.Object> getStartFormVariablesByProcessInstanceIdWithoutPermissionCheck(java.lang.String processInstanceId)

getStartFormForProcessInstanceId

public org.flowable.form.api.FormInfo getStartFormForProcessInstanceId(java.lang.String processInstanceId)

startNewProcessInstance

public ProcessInstanceRepresentation startNewProcessInstance(CreateProcessInstanceRepresentation startRequest,
                                                             boolean includeTranslations,
                                                             boolean createTestDefinition)

getWorkFormForProcessInstanceId

public org.flowable.form.api.FormInfo getWorkFormForProcessInstanceId(java.lang.String processInstanceId)

getFormInfo

protected org.flowable.form.api.FormInfo getFormInfo(java.lang.String processInstanceId,
                                                     java.lang.String deploymentId,
                                                     java.lang.String processDefinitionId,
                                                     java.lang.String tenantId)

getExtensionElementText

protected java.lang.String getExtensionElementText(org.flowable.bpmn.model.BaseElement baseElement,
                                                   java.lang.String extensionElementName)

saveWorkForm

public void saveWorkForm(java.lang.String processInstanceId,
                         java.util.Map<java.lang.String,java.lang.Object> variables)

saveDocuments

public void saveDocuments(java.lang.String processInstanceId,
                          java.util.Map<java.lang.String,java.lang.Object> variables)

getVariablesByProcessInstanceIdWithPermissionCheck

public java.util.Map<java.lang.String,java.lang.Object> getVariablesByProcessInstanceIdWithPermissionCheck(java.lang.String processInstanceId,
                                                                                                                 java.lang.String subScopeId)

getVariablesByProcessInstanceId

public java.util.Map<java.lang.String,java.lang.Object> getVariablesByProcessInstanceId(java.lang.String processInstanceId,
                                                                                              java.lang.String subScopeId)

assign

@Transactional
public void assign(java.lang.String processInstanceId,
                   java.lang.String userId)

getProcessVariables

protected java.util.Map<java.lang.String,java.lang.Object> getProcessVariables(java.lang.String processInstanceId)

getHistoricVariables

protected java.util.Map<java.lang.String,java.lang.Object> getHistoricVariables(java.lang.String processInstanceId)

fetchProcessInstance

protected org.flowable.engine.runtime.ProcessInstance fetchProcessInstance(java.lang.String processInstanceId)

fetchProcessInstanceWithHistory

protected ProcessInstanceInfo fetchProcessInstanceWithHistory(java.lang.String processInstanceId)

transformVariables

protected void transformVariables(java.util.Map<java.lang.String,java.lang.Object> variables)

isFormFieldValidationEnabled

protected boolean isFormFieldValidationEnabled(org.flowable.common.engine.api.variable.VariableContainer variableContainer,
                                               java.lang.String workFormValidationExpression)

getWorkFormValidationExpression

protected java.lang.String getWorkFormValidationExpression(java.lang.String processDefinitionId)

logSaveProcessEvent

protected void logSaveProcessEvent(org.flowable.engine.runtime.ProcessInstance processInstance)

getProcessInstanceComments

public org.flowable.common.rest.api.DataResponse<CommentInstanceRepresentation> getProcessInstanceComments(CommentQueryRequest request)

createProcessInstanceComment

public CommentInstanceRepresentation createProcessInstanceComment(java.lang.String processInstanceId,
                                                                  java.lang.String commentContent)

updateProcessInstanceComment

public CommentInstanceRepresentation updateProcessInstanceComment(java.lang.String processInstanceId,
                                                                  java.lang.String commentId,
                                                                  java.lang.String commentContent)

deleteProcessInstanceComment

public void deleteProcessInstanceComment(java.lang.String processInstanceId,
                                         java.lang.String commentId)

getContentItem

public org.flowable.content.api.ContentItem getContentItem(java.lang.String processInstanceId,
                                                           java.lang.String contentItemId)