Package com.flowable.platform.service.caze

Class PlatformCaseInstanceService

java.lang.Object

com.flowable.platform.security.service.AbstractPlatformSecurityService

com.flowable.platform.service.caze.PlatformCaseInstanceService

All Implemented Interfaces:

PermissionServiceRegistryAware, Aware

@Transactional
public class PlatformCaseInstanceService
extends AbstractPlatformSecurityService

Author:

Yvo Swillens

Field Summary

Fields

Modifier and Type	Field	Description
protected AppEngine	appEngine
protected AuditService	auditService
protected CasePermissionService	casePermissionService
protected CmmnEngine	cmmnEngine
protected CmmnHistoryService	cmmnHistoryService
protected PlatformContentItemService	contentItemService
protected CoreContentService	contentService
protected CoreRestDataInterceptor	coreRestDataInterceptor
protected final String	defaultHeaderConfig
protected DocumentMetadataHandler	documentMetadataHandler
protected DocumentRepositoryService	documentRepositoryService
protected final boolean	enableAuditLog
protected CoreFormService	formService
protected FormServiceInvoker	formServiceInvoker
protected HistoryService	historyService
protected PlatformIdentityService	identityService
protected ObjectProvider<InspectCaseInstanceInterceptor>	inspectCaseInstanceInterceptor
protected MetadataService	metadataService
protected com.fasterxml.jackson.databind.ObjectMapper	objectMapper
protected String	participantCandidateGroups
protected PlatformCommentService	platformCommentService
protected PlatformContentItemPermissionHandler	platformContentItemPermissionHandler
protected PlatformTranslationService	platformTranslationService
protected ScopedFormProvider	scopedFormProvider
protected PlatformRestVariableTransformer	variableTransformer

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

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

Constructor Summary

Constructors

Constructor	Description
PlatformCaseInstanceService(boolean enableAuditLog, String defaultHeaderConfig, String participantCandidateGroups)

Method Summary

Modifier and Type	Method	Description
protected void	addTranslations(CaseInstanceRepresentation caseInstanceRepresentation, CaseDefinition caseDefinition)
void	assign(String caseInstanceId, String userId)
PlatformUserQuery	createCandidateParticipantUsersQuery(String caseInstanceId, PlatformUserQueryRequest request)
CommentInstanceRepresentation	createCaseInstanceComment(String caseInstanceId, String commentContent)
protected HeaderConfigRepresentation	createHeaderConfig(String caseHeaderConfig, String casePageHeaderConfig, String localHeaderConfig, String hideSaveButton)
protected NavigationElementRepresentation	createNavigationElementRepresentation(ExtensionElement extensionElement, String caseHeaderConfig, String casePageHeaderConfig, ExpressionManager expressionManager, VariableContainer variableContainer)
protected PlatformUserQuery	createPlatformUserQuery(PlatformUserQueryRequest request)
protected VariableContainer	createVariableContainerForHistoricCaseInstance(HistoricCaseInstance historicCaseInstance)
void	deleteCaseInstanceComment(String caseInstanceId, String commentId)
protected CaseInstance	fetchCaseInstance(String caseInstanceId)
protected CaseInstanceInfo	fetchCaseInstanceWithHistory(String caseInstanceId)
protected void	fillHistoricNavigationElements(NavigationResponseRepresentation navigationResponse, String caseHeaderConfig, CaseInstanceInfo caseInstance, CmmnModel cmmnModel, Map<String,BpmnModel> bpmnModelMap, Map<String,CmmnModel> cmmnModelMap)
protected void	fillRuntimeNavigationElements(NavigationResponseRepresentation navigationResponse, String caseHeaderConfig, CaseInstanceInfo caseInstance, CmmnModel cmmnModel, Map<String,BpmnModel> bpmnModelMap, Map<String,CmmnModel> cmmnModelMap)
protected void	fillStaticCasePageElements(PlanItemDefinition planItemDefinition, String caseHeaderConfig, String casePageHeaderConfig, String renderedState, NavigationResponseRepresentation navigationResponse, VariableContainer variableContainer)
protected void	fillStaticPageElements(ExtensionElement customViewElement, NavigationResponseRepresentation navigationResponse)
CaseInstanceRepresentation	getCaseInstance(String caseInstanceId, boolean includeTranslations)
List<CasePageTaskRepresentation>	getCaseInstanceCasePageTasks(String caseInstanceId)
DataResponse<CommentInstanceRepresentation>	getCaseInstanceComments(CommentQueryRequest request)
StatusOptionsRepresentation	getCaseInstanceStatusOptions(String caseInstanceId)
protected Map<String,Object>	getCaseVariables(String caseInstanceId)
ContentItem	getContentItem(String caseInstanceId, String contentItemId)
protected String	getExtensionElementValue(String name, CmmnElement cmmnElement)
protected Map<String,Object>	getHistoricVariables(String caseInstanceId)
protected String	getIdentityLinkRenderedStateValue(List<? extends IdentityLinkInfo> identityLinks)
ContentItem	getLatestContentItem(String caseInstanceId, String contentItemId)
NavigationResponseRepresentation	getNavigationElements(String caseInstanceId)
protected List<String>	getPermissionGroupList(String permissionGroups)
protected String	getRenderedStateValue(String renderingValue)
protected String	getRenderedStateValue(FlowElement flowElement, String taskState)
protected String	getRenderedStateValue(PlanItemDefinition planItemDefinition, String planItemState)
protected String	getRenderedStateValue(PlanItemDefinition planItemDefinition, String subScopeId, Map<String,String> taskPlanItemStateMap)
List<StageRepresentation>	getStageOverview(String caseInstanceId)
FormInfo	getStartFormForCaseInstanceId(String caseInstanceId)
Map<String,Object>	getStartFormVariablesByCaseInstanceId(String caseInstanceId)
protected Map<String,Object>	getStartFormVariablesByCaseInstanceIdWithoutPermissionCheck(String caseInstanceId)
Map<String,Object>	getVariablesByCaseInstanceId(String caseInstanceId)
Map<String,Object>	getVariablesByCaseInstanceIdWithPermissionCheck(String caseInstanceId)
FormInfo	getWorkFormForCaseInstanceId(String caseInstanceId)
protected String	getWorkFormValidationExpression(String caseDefinitionId)
ServiceInvocationResultResponseResponse	invokeFormFieldService(String caseInstanceId, String fieldId, Map<String,Object> serviceInvocationInput)
protected boolean	isFormFieldValidationEnabled(VariableContainer variableContainer, String workFormValidationExpression)
protected void	logSaveCaseEvent(CaseInstance caseInstance)
protected String	resolvePotentialStringExpression(String value, ExpressionManager expressionManager, VariableContainer variableContainer)
void	saveDocuments(String caseInstanceId, Map<String,Object> variables)
void	saveWorkForm(String caseInstanceId, Map<String,Object> variables)
CaseInstanceRepresentation	startNewCaseInstance(CreateCaseInstanceRepresentation startRequest, boolean includeTranslations, boolean createTestDefinition)
protected void	transformVariables(Map<String,Object> variables)
CommentInstanceRepresentation	updateCaseInstanceComment(String caseInstanceId, String commentId, String commentContent)
void	updateCaseInstanceStatus(String caseInstanceId, String status)

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, getCurrentSecurityScope, 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 Details

enableAuditLog

protected final boolean enableAuditLog

defaultHeaderConfig

protected final String defaultHeaderConfig

participantCandidateGroups

protected String participantCandidateGroups

cmmnHistoryService

@Autowired
protected CmmnHistoryService cmmnHistoryService

formService

@Autowired
protected CoreFormService formService

formServiceInvoker

@Autowired
protected FormServiceInvoker formServiceInvoker

historyService

@Autowired
protected HistoryService historyService

platformTranslationService

@Autowired(required=false)
protected PlatformTranslationService platformTranslationService

platformCommentService

@Autowired(required=false)
protected PlatformCommentService platformCommentService

auditService

@Autowired(required=false)
protected AuditService auditService

contentItemService

@Autowired(required=false)
protected PlatformContentItemService contentItemService

contentService

@Autowired(required=false)
protected CoreContentService contentService

metadataService

@Autowired(required=false)
protected MetadataService metadataService

documentRepositoryService

@Autowired(required=false)
protected DocumentRepositoryService documentRepositoryService

documentMetadataHandler

@Autowired(required=false)
protected DocumentMetadataHandler documentMetadataHandler

platformContentItemPermissionHandler

@Autowired(required=false)
protected PlatformContentItemPermissionHandler platformContentItemPermissionHandler

coreRestDataInterceptor

@Autowired(required=false)
protected CoreRestDataInterceptor coreRestDataInterceptor

casePermissionService

@Autowired
protected CasePermissionService casePermissionService

inspectCaseInstanceInterceptor

@Autowired
protected ObjectProvider<InspectCaseInstanceInterceptor> inspectCaseInstanceInterceptor

variableTransformer

@Autowired
protected PlatformRestVariableTransformer variableTransformer

cmmnEngine

@Autowired
protected CmmnEngine cmmnEngine

appEngine

@Autowired
protected AppEngine appEngine

objectMapper

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

scopedFormProvider

@Autowired
protected ScopedFormProvider scopedFormProvider

identityService

@Autowired
protected PlatformIdentityService identityService

Constructor Details

PlatformCaseInstanceService

public PlatformCaseInstanceService(boolean enableAuditLog,
 String defaultHeaderConfig,
 String participantCandidateGroups)

Method Details

createCandidateParticipantUsersQuery

public PlatformUserQuery createCandidateParticipantUsersQuery(String caseInstanceId,
 PlatformUserQueryRequest request)

createPlatformUserQuery

protected PlatformUserQuery createPlatformUserQuery(PlatformUserQueryRequest request)

getCaseInstance

public CaseInstanceRepresentation getCaseInstance(String caseInstanceId,
 boolean includeTranslations)

getStageOverview

public List<StageRepresentation> getStageOverview(String caseInstanceId)

getCaseInstanceStatusOptions

public StatusOptionsRepresentation getCaseInstanceStatusOptions(String caseInstanceId)

invokeFormFieldService

public ServiceInvocationResultResponseResponse invokeFormFieldService(String caseInstanceId,
 String fieldId,
 Map<String,Object> serviceInvocationInput)

updateCaseInstanceStatus

public void updateCaseInstanceStatus(String caseInstanceId,
 String status)

addTranslations

protected void addTranslations(CaseInstanceRepresentation caseInstanceRepresentation,
 CaseDefinition caseDefinition)

getCaseInstanceComments

public DataResponse<CommentInstanceRepresentation> getCaseInstanceComments(CommentQueryRequest request)

createCaseInstanceComment

public CommentInstanceRepresentation createCaseInstanceComment(String caseInstanceId,
 String commentContent)

updateCaseInstanceComment

public CommentInstanceRepresentation updateCaseInstanceComment(String caseInstanceId,
 String commentId,
 String commentContent)

deleteCaseInstanceComment

public void deleteCaseInstanceComment(String caseInstanceId,
 String commentId)

getStartFormVariablesByCaseInstanceId

public Map<String,Object> getStartFormVariablesByCaseInstanceId(String caseInstanceId)

getStartFormVariablesByCaseInstanceIdWithoutPermissionCheck

protected Map<String,Object> getStartFormVariablesByCaseInstanceIdWithoutPermissionCheck(String caseInstanceId)

getStartFormForCaseInstanceId

public FormInfo getStartFormForCaseInstanceId(String caseInstanceId)

startNewCaseInstance

public CaseInstanceRepresentation startNewCaseInstance(CreateCaseInstanceRepresentation startRequest,
 boolean includeTranslations,
 boolean createTestDefinition)

getWorkFormForCaseInstanceId

public FormInfo getWorkFormForCaseInstanceId(String caseInstanceId)

saveWorkForm

public void saveWorkForm(String caseInstanceId,
 Map<String,Object> variables)

getNavigationElements

public NavigationResponseRepresentation getNavigationElements(String caseInstanceId)

getCaseInstanceCasePageTasks

public List<CasePageTaskRepresentation> getCaseInstanceCasePageTasks(String caseInstanceId)

saveDocuments

public void saveDocuments(String caseInstanceId,
 Map<String,Object> variables)

getVariablesByCaseInstanceIdWithPermissionCheck

public Map<String,Object> getVariablesByCaseInstanceIdWithPermissionCheck(String caseInstanceId)

getVariablesByCaseInstanceId

public Map<String,Object> getVariablesByCaseInstanceId(String caseInstanceId)

getContentItem

public ContentItem getContentItem(String caseInstanceId,
 String contentItemId)

getLatestContentItem

public ContentItem getLatestContentItem(String caseInstanceId,
 String contentItemId)

assign

@Transactional
public void assign(String caseInstanceId,
 String userId)

fillRuntimeNavigationElements

protected void fillRuntimeNavigationElements(NavigationResponseRepresentation navigationResponse,
 String caseHeaderConfig,
 CaseInstanceInfo caseInstance,
 CmmnModel cmmnModel,
 Map<String,BpmnModel> bpmnModelMap,
 Map<String,CmmnModel> cmmnModelMap)

fillHistoricNavigationElements

protected void fillHistoricNavigationElements(NavigationResponseRepresentation navigationResponse,
 String caseHeaderConfig,
 CaseInstanceInfo caseInstance,
 CmmnModel cmmnModel,
 Map<String,BpmnModel> bpmnModelMap,
 Map<String,CmmnModel> cmmnModelMap)

createVariableContainerForHistoricCaseInstance

protected VariableContainer createVariableContainerForHistoricCaseInstance(HistoricCaseInstance historicCaseInstance)

getRenderedStateValue

protected String getRenderedStateValue(PlanItemDefinition planItemDefinition,
 String subScopeId,
 Map<String,String> taskPlanItemStateMap)

getRenderedStateValue

protected String getRenderedStateValue(PlanItemDefinition planItemDefinition,
 String planItemState)

getRenderedStateValue

protected String getRenderedStateValue(String renderingValue)

getRenderedStateValue

protected String getRenderedStateValue(FlowElement flowElement,
 String taskState)

getIdentityLinkRenderedStateValue

protected String getIdentityLinkRenderedStateValue(List<? extends IdentityLinkInfo> identityLinks)

fillStaticPageElements

protected void fillStaticPageElements(ExtensionElement customViewElement,
 NavigationResponseRepresentation navigationResponse)

fillStaticCasePageElements

protected void fillStaticCasePageElements(PlanItemDefinition planItemDefinition,
 String caseHeaderConfig,
 String casePageHeaderConfig,
 String renderedState,
 NavigationResponseRepresentation navigationResponse,
 VariableContainer variableContainer)

createNavigationElementRepresentation

protected NavigationElementRepresentation createNavigationElementRepresentation(ExtensionElement extensionElement,
 String caseHeaderConfig,
 String casePageHeaderConfig,
 ExpressionManager expressionManager,
 VariableContainer variableContainer)

resolvePotentialStringExpression

protected String resolvePotentialStringExpression(String value,
 ExpressionManager expressionManager,
 VariableContainer variableContainer)

getCaseVariables

protected Map<String,Object> getCaseVariables(String caseInstanceId)

getHistoricVariables

protected Map<String,Object> getHistoricVariables(String caseInstanceId)

fetchCaseInstance

protected CaseInstance fetchCaseInstance(String caseInstanceId)

fetchCaseInstanceWithHistory

protected CaseInstanceInfo fetchCaseInstanceWithHistory(String caseInstanceId)

transformVariables

protected void transformVariables(Map<String,Object> variables)

isFormFieldValidationEnabled

protected boolean isFormFieldValidationEnabled(VariableContainer variableContainer,
 String workFormValidationExpression)

getWorkFormValidationExpression

protected String getWorkFormValidationExpression(String caseDefinitionId)

getPermissionGroupList

protected List<String> getPermissionGroupList(String permissionGroups)

logSaveCaseEvent

protected void logSaveCaseEvent(CaseInstance caseInstance)

createHeaderConfig

protected HeaderConfigRepresentation createHeaderConfig(String caseHeaderConfig,
 String casePageHeaderConfig,
 String localHeaderConfig,
 String hideSaveButton)

getExtensionElementValue

protected String getExtensionElementValue(String name,
 CmmnElement cmmnElement)