org.camunda.bpm.engine.impl.management
Interface PurgeReporting<T>

All Known Implementing Classes:

CachePurgeReport, DatabasePurgeReport

public interface PurgeReporting<T>

Represents an interface for the purge reporting. Contains all information of the data which is deleted during the purge.

Author:

Christopher Zell

Method Summary

void	addPurgeInformation(String key, T value) Adds the key value pair as report information to the current purge report.
boolean	containsReport(String key) Returns true if the key is present in the current report.
Map<String,T>	getPurgeReport() Returns the current purge report.
String	getPurgeReportAsString() Transforms and returns the purge report to a string.
T	getReportValue(String key) Returns the value for the given key.
boolean	isEmpty() Returns true if the report is empty.

Method Detail

addPurgeInformation

void addPurgeInformation(String key,
                         T value)

Adds the key value pair as report information to the current purge report.

Parameters:

key - the report key

value - the report value

getPurgeReport

Map<String,T> getPurgeReport()

Returns the current purge report.

Returns:

the purge report

getPurgeReportAsString

String getPurgeReportAsString()

Transforms and returns the purge report to a string.

Returns:

the purge report as string

getReportValue

T getReportValue(String key)

Returns the value for the given key.

Parameters:

key - the key which exist in the current report

Returns:

the corresponding value

containsReport

boolean containsReport(String key)

Returns true if the key is present in the current report.

Parameters:

key - the key

Returns:

true if the key is present

isEmpty

boolean isEmpty()

Returns true if the report is empty.

Returns:

true if the report is empty, false otherwise