org.jbpm.pvm.log
Class ProcessLog

java.lang.Object
  org.jbpm.pvm.log.ProcessLog

All Implemented Interfaces:

java.io.Serializable

public abstract class ProcessLog
extends java.lang.Object
implements java.io.Serializable

base class for process logs. Process logs are dispatched to the LogSession that is configured in the environment.

ProcessLogs that are send to a LogSession is the probe mechanism provided to listen into the process execution progress and details. It is the mechanism to collect process history and process statistics.

Author:

Tom Baeyens

See Also:

Serialized Form

Field Summary

protected long	dbid
protected Execution	execution
protected int	index
protected Execution	processInstance
protected java.util.Date	time

Constructor Summary

ProcessLog()

Method Summary

long	getDbid()
Execution	getExecution()
int	getIndex()
Execution	getProcessInstance()
abstract java.util.List<ProcessLogProperty>	getProperties() xml representation of the process log properties used for XML serialization.
java.util.Date	getTime()
abstract java.lang.String	getType() text id of the type of this process log used for XML serialization.
void	setExecution(ExecutionImpl execution)
void	setTime(java.util.Date date)
java.lang.String	toString() provides a text description for this update which can be used e.g. in the admin web console.

Methods inherited from class java.lang.Object

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

Field Detail

dbid

protected long dbid

index

protected int index

time

protected java.util.Date time

execution

protected Execution execution

processInstance

protected Execution processInstance

Constructor Detail

ProcessLog

public ProcessLog()

Method Detail

setExecution

public void setExecution(ExecutionImpl execution)

getType

public abstract java.lang.String getType()

text id of the type of this process log used for XML serialization.

getProperties

public abstract java.util.List<ProcessLogProperty> getProperties()

xml representation of the process log properties used for XML serialization. Properties time, execution and processInstance should not be included. This method is made abstract to remind and encourage implementors to provide XML serialization capabilities to the fixed process log XML schema. But it is allowed to return null if XML serialisation if you're sure that XML serialization will never be necessary.

toString

public java.lang.String toString()

provides a text description for this update which can be used e.g. in the admin web console. This texts hould not contain time, execution nor processInstance. The default implementation will include the type and then append all the top level properties.

Overrides:

toString in class java.lang.Object

getDbid

public long getDbid()

getTime

public java.util.Date getTime()

setTime

public void setTime(java.util.Date date)

getExecution

public Execution getExecution()

getIndex

public int getIndex()

getProcessInstance

public Execution getProcessInstance()