Package 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

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void addPurgeInformation​(java.lang.String key, T value)
      Adds the key value pair as report information to the current purge report.
      boolean containsReport​(java.lang.String key)
      Returns true if the key is present in the current report.
      java.util.Map<java.lang.String,​T> getPurgeReport()
      Returns the current purge report.
      java.lang.String getPurgeReportAsString()
      Transforms and returns the purge report to a string.
      T getReportValue​(java.lang.String key)
      Returns the value for the given key.
      boolean isEmpty()
      Returns true if the report is empty.

    • Method Detail

      • addPurgeInformation

        void addPurgeInformation​(java.lang.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

        java.util.Map<java.lang.String,​T> getPurgeReport()
        Returns the current purge report.
        Returns:
        the purge report

      • getPurgeReportAsString

        java.lang.String getPurgeReportAsString()
        Transforms and returns the purge report to a string.
        Returns:
        the purge report as string

      • getReportValue

        T getReportValue​(java.lang.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​(java.lang.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