org.jahia.services.workflow

Class HistoryWorkflowBase

java.lang.Object

org.jahia.services.workflow.WorkflowBase

org.jahia.services.workflow.HistoryWorkflowBase

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

HistoryWorkflow, HistoryWorkflowAction

public class HistoryWorkflowBase
extends WorkflowBase

History record for a workflow process instance.

Author:

Sergiy Shyrkov

See Also:

Serialized Form

Field Summary

Fields inherited from class org.jahia.services.workflow.WorkflowBase

displayName

Constructor Summary

Constructors

Constructor and Description
HistoryWorkflowBase(String processId, String name, String provider, String user, Date startTime, Date endTime) Initializes an instance of this class.

Method Summary

Modifier and Type	Method and Description
Long	getDuration() duration of the process instance in milliseconds or null if the process instance has not yet ended
Date	getEndTime() Returns the time when the process instance ended (only not null if the process instance already ended).
String	getProcessId() Returns an ID of the corresponding workflow process instance.
Date	getStartTime() Returns the time when the process instance was started.
String	getUser()
boolean	isCompleted()
void	setEndTime(Date endTime) Sets the end time for the workflow process instance.

Methods inherited from class org.jahia.services.workflow.WorkflowBase

getDisplayName, getName, getProvider, setDisplayName, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

HistoryWorkflowBase

public HistoryWorkflowBase(String processId,
                           String name,
                           String provider,
                           String user,
                           Date startTime,
                           Date endTime)

Initializes an instance of this class.

Parameters:

processId - the ID of the corresponding workflow process instance

name - the name of the item

provider - the provider key

user -

startTime - the start point of the process instance

endTime - the end point of the process instance or null

Method Detail

getDuration

public Long getDuration()

duration of the process instance in milliseconds or null if the process instance has not yet ended

getEndTime

public Date getEndTime()

Returns the time when the process instance ended (only not null if the process instance already ended).

Returns:

the time when the process instance ended (only not null if the process instance already ended)

getStartTime

public Date getStartTime()

Returns the time when the process instance was started.

Returns:

the time when the process instance was started

isCompleted

public boolean isCompleted()

getUser

public String getUser()

getProcessId

public String getProcessId()

Returns an ID of the corresponding workflow process instance.

Returns:

an ID of the corresponding workflow process instance

setEndTime

public void setEndTime(Date endTime)

Sets the end time for the workflow process instance.

Parameters:

endTime - the endTime to set