org.camunda.bpm.engine.impl.history
Class HistoryLevelAudit

java.lang.Object
  org.camunda.bpm.engine.impl.history.AbstractHistoryLevel
      org.camunda.bpm.engine.impl.history.HistoryLevelActivity
          org.camunda.bpm.engine.impl.history.HistoryLevelAudit

All Implemented Interfaces:

HistoryLevel

public class HistoryLevelAudit
extends HistoryLevelActivity

Author:

Daniel Meyer

Field Summary

Fields inherited from interface org.camunda.bpm.engine.impl.history.HistoryLevel

HISTORY_LEVEL_ACTIVITY, HISTORY_LEVEL_AUDIT, HISTORY_LEVEL_FULL, HISTORY_LEVEL_NONE

Constructor Summary

HistoryLevelAudit()

Method Summary

int	getId() An unique id identifying the history level.
String	getName() An unique name identifying the history level.
boolean	isHistoryEventProduced(HistoryEventType eventType, Object entity) Returns true if a given history event should be produced.

Methods inherited from class org.camunda.bpm.engine.impl.history.AbstractHistoryLevel

equals, hashCode

Methods inherited from class java.lang.Object

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

Constructor Detail

HistoryLevelAudit

public HistoryLevelAudit()

Method Detail

getId

public int getId()

Description copied from interface: HistoryLevel

An unique id identifying the history level. The id is used internally to uniquely identify the history level and also stored in the database.

Specified by:

getId in interface HistoryLevel

Overrides:

getId in class HistoryLevelActivity

getName

public String getName()

Description copied from interface: HistoryLevel

An unique name identifying the history level. The name of the history level can be used when configuring the process engine.

Specified by:

getName in interface HistoryLevel

Overrides:

getName in class HistoryLevelActivity

See Also:

ProcessEngineConfiguration#setHistory(String)}

isHistoryEventProduced

public boolean isHistoryEventProduced(HistoryEventType eventType,
                                      Object entity)

Description copied from interface: HistoryLevel

Returns true if a given history event should be produced.

Specified by:

isHistoryEventProduced in interface HistoryLevel

Overrides:

isHistoryEventProduced in class HistoryLevelActivity

Parameters:

eventType - the type of the history event which is about to be produced

entity - the runtime structure used to produce the history event. Examples ExecutionEntity, TaskEntity, VariableInstanceEntity, ... If a 'null' value is provided, the implementation should return true if events of this type should be produced "in general".