Interface HvlBpmnProcessService
- All Known Implementing Classes:
HvlBpmnProcessServiceImpl
@Validated
public interface HvlBpmnProcessService
This service provides operational and retrieve methods for bpmn processes.
-
Method Summary
Modifier and TypeMethodDescriptionvoid
Removes object according to provided parameter.void
deployProcess
(@NotNull Long id) Deploy process.byte[]
Exports all processes as zip file.exportProcess
(@NotNull Long id) Exports process as bpmn xml.Gets namespace list.getProcessById
(@NotNull Long id) Gets process by id.getProcessByKey
(@NotNull String key) Gets process by key.com.fasterxml.jackson.databind.node.ObjectNode
getProcessModelNode
(@NotNull Long modelId) Gets process model node.importAll
(byte[] zipBytes) Imports all bpmn xml files from a zip file.importProcess
(byte[] xmlBytes, boolean isSystemProcess) Imports a bpmn xml.boolean
Check the process is locked.boolean
isProcessDeploymentExist
(@NotBlank String key) Checks if there is any deployed process exists with given key.boolean
isProcessInstanceExist
(@NotBlank String key, @NotNull Integer version) Checks if there is any process instance exists with given key and versionboolean
isSystemProcess
(@NotNull String processUuid) Check the process is system processvoid
Lock the process.queryCategoryList
(@NotBlank @Size(min=3,max=64) String namespace) Query as list.queryList
(@NotNull HvlBpmnProcessQueryModel processQueryModel) Query as list.tr.com.havelsan.javarch.data.commons.pageable.HvlPage
<HvlBpmnProcessModel> queryPage
(@NotNull HvlBpmnProcessQueryModel processQueryModel) Query as page.save
(@Valid HvlBpmnProcessModel processModel, Long sourceProcessId) Adds provided object.void
saveProcessModelNode
(@NotNull Long modelId, @NotEmpty org.springframework.util.MultiValueMap<String, String> values) Saves process model node.void
Unlock the process.update
(@Valid HvlBpmnProcessModel processModel, boolean newVersion, HvlBpmnProcessUpdateType updateType) Edits object associated provided object.void
upgradeVersion
(@NotNull String processDefinitionKey, byte[] upgradedProcessDefinitionXmlFile) Upgrade existing process definition.
-
Method Details
-
save
Adds provided object.- Parameters:
processModel
- the process modelsourceProcessId
- the source process's id if cloning is wanted- Returns:
- the long
-
update
Long update(@Valid @Valid HvlBpmnProcessModel processModel, boolean newVersion, HvlBpmnProcessUpdateType updateType) Edits object associated provided object.- Parameters:
processModel
- the process modelnewVersion
- the new versionupdateType
- the update type- Returns:
- the long
-
delete
Removes object according to provided parameter.- Parameters:
id
- the id
-
deployProcess
Deploy process.- Parameters:
id
- the id
-
importProcess
Imports a bpmn xml.- Parameters:
xmlBytes
- the xml bytesisSystemProcess
- the is system process- Returns:
- the HvlProcessDefinitionImportResultModel
-
importAll
Imports all bpmn xml files from a zip file.- Parameters:
zipBytes
- the zip bytes- Returns:
- the list
- Throws:
IOException
- the io exception
-
exportProcess
Exports process as bpmn xml.- Parameters:
id
- the id- Returns:
- the map
-
exportAll
Exports all processes as zip file.- Parameters:
idList
- the id list- Returns:
- the byte [ ]
- Throws:
IOException
- the io exception
-
queryList
Query as list.- Parameters:
processQueryModel
- the process query model- Returns:
- the list
-
queryPage
tr.com.havelsan.javarch.data.commons.pageable.HvlPage<HvlBpmnProcessModel> queryPage(@NotNull @NotNull HvlBpmnProcessQueryModel processQueryModel) Query as page.- Parameters:
processQueryModel
- the process query model- Returns:
- the hvl page
-
queryCategoryList
List<String> queryCategoryList(@NotBlank @Size(min=3,max=64) @NotBlank @Size(min=3,max=64) String namespace) Query as list.- Parameters:
namespace
- the namespace- Returns:
- the list
-
lock
Lock the process.- Parameters:
id
- the id
-
unlock
Unlock the process.- Parameters:
id
- the id
-
isLocked
Check the process is locked.- Parameters:
id
- the id- Returns:
- the boolean
-
getProcessById
Gets process by id.- Parameters:
id
- the id- Returns:
- the process by id
-
getProcessByKey
Gets process by key.- Parameters:
key
- the key- Returns:
- the process model
-
isSystemProcess
Check the process is system process- Parameters:
processUuid
- the process uuid- Returns:
- the boolean
-
getProcessModelNode
Gets process model node.- Parameters:
modelId
- the model id- Returns:
- the process model node
-
saveProcessModelNode
void saveProcessModelNode(@NotNull @NotNull Long modelId, @NotEmpty @NotEmpty org.springframework.util.MultiValueMap<String, String> values) Saves process model node.- Parameters:
modelId
- the model idvalues
- the values
-
getNamespaceList
Gets namespace list.- Returns:
- the namespace list
-
upgradeVersion
void upgradeVersion(@NotNull @NotNull String processDefinitionKey, byte[] upgradedProcessDefinitionXmlFile) Upgrade existing process definition.- Parameters:
processDefinitionKey
- the process definition keyupgradedProcessDefinitionXmlFile
- the upgraded process definition xml file
-
isProcessDeploymentExist
Checks if there is any deployed process exists with given key.- Parameters:
key
- process definition key- Returns:
- boolean boolean
-
isProcessInstanceExist
Checks if there is any process instance exists with given key and version- Parameters:
key
- process definition keyversion
- process definition version- Returns:
- boolean boolean
-