Package fr.gouv.vitam.processing.common.model

Class ProcessStep

java.lang.Object

fr.gouv.vitam.common.model.processing.Step

fr.gouv.vitam.processing.common.model.ProcessStep

public class ProcessStep
extends Step

Step Object in process workflow

Constructor Summary

Constructors

Constructor	Description
ProcessStep(Step step, long elementToProcess, long elementProcessed)	Constructor to initialize a Process Step with a Step object
ProcessStep(Step step, long elementToProcess, long elementProcessed, java.lang.String id)
ProcessStep(Step step, java.lang.String containerName, java.lang.String workflowId, int position, long elementToProcess, long elementProcessed)	Constructor to initalize a Process Step with a Step object
ProcessStep(Step step, java.lang.String id, java.lang.String containerName, java.lang.String workflowId, int position, long elementToProcess, long elementProcessed)

Method Summary

Modifier and Type	Method	Description
boolean	equals(java.lang.Object object)	Considered equal two ProcessStep with the same id, step name and worker group id.
long	getElementProcessed()
long	getElementToProcess()
StatusCode	getStepStatusCode()
int	hashCode()
ProcessStep	setElementProcessed(long elementProcessed)
ProcessStep	setElementToProcess(long elementToProcess)
ProcessStep	setStepStatusCode(StatusCode stepStatusCode)
java.lang.String	toString()

Methods inherited from class fr.gouv.vitam.common.model.processing.Step

defaultLifecycleLog, getActions, getBehavior, getDistribution, getId, getPauseOrCancelAction, getStepName, getStepResponses, getWorkerGroupId, isBlocking, setActions, setBehavior, setDistribution, setId, setPauseOrCancelAction, setStepName, setStepResponses, setWorkerGroupId, shallStop

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ProcessStep

public ProcessStep(Step step,
                   long elementToProcess,
                   long elementProcessed,
                   java.lang.String id)

ProcessStep

public ProcessStep(Step step,
                   long elementToProcess,
                   long elementProcessed)

Constructor to initialize a Process Step with a Step object

Parameters:

step - the Step object

elementToProcess - number of element to process

elementProcessed - number of element processed

Throws:

java.lang.IllegalArgumentException - if the step is null

ProcessStep

public ProcessStep(Step step,
                   java.lang.String id,
                   java.lang.String containerName,
                   java.lang.String workflowId,
                   int position,
                   long elementToProcess,
                   long elementProcessed)

ProcessStep

public ProcessStep(Step step,
                   java.lang.String containerName,
                   java.lang.String workflowId,
                   int position,
                   long elementToProcess,
                   long elementProcessed)

Constructor to initalize a Process Step with a Step object

Parameters:

step - the Step object

containerName - the container name concerned by the process

workflowId - the workflow ID concerned by the process

position - the position of the step

elementToProcess - number of element to process

elementProcessed - number of element processed

Throws:

java.lang.IllegalArgumentException - if the step is null

Method Detail

getElementProcessed

public long getElementProcessed()

Returns:

the elementProcessed

setElementProcessed

public ProcessStep setElementProcessed(long elementProcessed)

Parameters:

elementProcessed - the elementProcessed to set

Returns:

the updated ProcessStep object

getElementToProcess

public long getElementToProcess()

Returns:

the elementToProcess

setElementToProcess

public ProcessStep setElementToProcess(long elementToProcess)

Parameters:

elementToProcess - the elementToProcess to set

Returns:

the updated ProcessStep object

getStepStatusCode

public StatusCode getStepStatusCode()

Returns:

the stepStatusCode

setStepStatusCode

public ProcessStep setStepStatusCode(StatusCode stepStatusCode)

Parameters:

stepStatusCode - the stepStatusCode to set

Returns:

the updated ProcessStep object

equals

public boolean equals(java.lang.Object object)

Considered equal two ProcessStep with the same id, step name and worker group id.

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object