fr.gouv.vitam.processing.data.core

Interface ProcessDataAccess

All Known Implementing Classes:

ProcessDataAccessImpl

public interface ProcessDataAccess

Process Data Access Interface offers services

Method Summary

Modifier and Type	Method and Description
void	addToWorkflowList(ProcessWorkflow processWorkflow) Add process to Workflow Only use on application starting to load persisted workflow (state are PAUSED or FAILED only)
List<ProcessWorkflow>	findAllProcessWorkflow(Integer tenantId) Retrieves All the workflow process for monitoring purpose The final business scope of this feature is likely to be redefined, to match the future need
ProcessWorkflow	findOneProcessWorkflow(String processId, Integer tenantId) Gets Process Workflow by ID
Map<Integer,Map<String,ProcessWorkflow>>	getWorkFlowList() getter of WorkflowList
ProcessWorkflow	initProcessWorkflow(WorkFlow workflow, String containerName, LogbookTypeProcess logbookTypeProcess, Integer tenantId, String contextId) Allows a process to be initialized
void	updateStep(String processId, String uniqueId, long elementToProcessOrProcessed, boolean elementProcessed, Integer tenantId) Update a step in a workflow, knowing its unique id

Method Detail

initProcessWorkflow

ProcessWorkflow initProcessWorkflow(WorkFlow workflow,
                                    String containerName,
                                    LogbookTypeProcess logbookTypeProcess,
                                    Integer tenantId,
                                    String contextId)

Allows a process to be initialized

Parameters:

workflow - the workflow to init

containerName - : null not allowed , the name of the container to be processed

logbookTypeProcess - LogbookTypeProcess

tenantId - the working tenant

contextId - the context ID

Returns:

LogbookTypeProcess

updateStep

void updateStep(String processId,
                String uniqueId,
                long elementToProcessOrProcessed,
                boolean elementProcessed,
                Integer tenantId)

Update a step in a workflow, knowing its unique id

Parameters:

processId - the id of the process to be updated

uniqueId - the unique Id of the step

elementToProcessOrProcessed - the number of element to be processed

elementProcessed - if a new element has been processed

tenantId - the working tenant

Throws:

ProcessingException - if the step does not exist

findOneProcessWorkflow

ProcessWorkflow findOneProcessWorkflow(String processId,
                                       Integer tenantId)
                                throws WorkflowNotFoundException

Gets Process Workflow by ID

Parameters:

processId - the process id

tenantId - the working tenant

Returns:

ProcessWorkflow

Throws:

WorkflowNotFoundException - thrown when process workflow not found

findAllProcessWorkflow

List<ProcessWorkflow> findAllProcessWorkflow(Integer tenantId)

Retrieves All the workflow process for monitoring purpose The final business scope of this feature is likely to be redefined, to match the future need

Parameters:

tenantId - the working tenant

Returns:

All the workflow process details

addToWorkflowList

void addToWorkflowList(ProcessWorkflow processWorkflow)

Add process to Workflow
Only use on application starting to load persisted workflow (state are PAUSED or FAILED only)

Parameters:

processWorkflow - the loaded persisted process to add

getWorkFlowList

Map<Integer,Map<String,ProcessWorkflow>> getWorkFlowList()

getter of WorkflowList

Returns: