Package org.pentaho.platform.api.engine

Interface IAuditable

All Known Subinterfaces:
IComponent, IDataComponent, IPentahoSession, IPreparedComponent, IRuntimeContext
public interface IAuditable
Any subsystem that implements the IAuditable interface is candidate for auditing within the platform. This interface outlines the necessary pieces of information that an object must be able to return in order to be auditable.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getActionName()
    Return the name of the action sequence.
    String
    getId()
    Returns a unique id (across classes and instances) for this auditable object.
    String
    getObjectName()
    Returns the Java class name for this object.
    String
    getProcessId()
    Return the id for the execution of a given action sequence document.

  • Method Details

    • getObjectName

      String getObjectName()
      Returns the Java class name for this object.
      Returns:
      the name of the object (the Java class name)

    • getProcessId

      String getProcessId()
      Return the id for the execution of a given action sequence document.
      Returns:
      the process id

    • getActionName

      String getActionName()
      Return the name of the action sequence. Today, that name is synonymous with the name of the action sequence document in the solution repository.
      Returns:
      the name of the action sequence

    • getId

      String getId()
      Returns a unique id (across classes and instances) for this auditable object.
      Returns:
      the auditable's id