org.pentaho.platform.api.engine
Interface IAuditable

All Known Subinterfaces:

IComponent, IDataComponent, IPentahoSession, IPreparedComponent, IRuntimeContext

All Known Implementing Classes:

AbstractGenerateContentComponent, AbstractGenerateStreamContentComponent, AbstractJFreeReportComponent, BaseSession, BIRTReportComponent, ChartComponent, ComponentBase, ComponentImplementationExample, ContentOutputComponent, ContentRepositoryCleaner, Custom1, EmailComponent, HelloWorldComponent, HQLBaseComponent, HQLDataComponent, HQLLookupRule, InstanceEnd, JasperReportsComponent, JavascriptRule, JFreeReportAllContentComponent, JFreeReportComponent, JFreeReportConfigParameterComponent, JFreeReportCSVComponent, JFreeReportDataComponent, JFreeReportDirectoryHtmlComponent, JFreeReportExcelComponent, JFreeReportGenerateDefinitionComponent, JFreeReportGeneratorComponent, JFreeReportHtmlComponent, JFreeReportLoadComponent, JFreeReportParametersComponent, JFreeReportPdfComponent, JFreeReportPreviewSwingComponent, JFreeReportPrintComponent, JFreeReportRTFComponent, JFreeReportStreamHtmlComponent, JFreeReportValidateParametersComponent, JFreeReportXmlComponent, JFreeReportZipHtmlComponent, JobSchedulerComponent, KettleComponent, MDXBaseComponent, MDXDataComponent, MDXLookupRule, MockComponent, MondrianModelComponent, MQLRelationalDataComponent, OpenFlashChartComponent, PentahoHttpSession, PentahoPortletSession, PentahoVersionCheckComponent, PivotViewComponent, PojoComponent, PojoComponent, PrintComponent, ReportWizardSpecComponent, ResultSetCompareComponent, ResultSetCrosstabComponent, ResultSetExportComponent, ResultSetFlattenerComponent, RuntimeContext, SchedulerAdminComponent, SecureFilterComponent, SQLBaseComponent, SQLDataComponent, SQLDdlComponent, SQLExecute, SQLLookupRule, StandaloneSession, SubActionComponent, SystemStartupSession, TemplateComponent, TestComponent, TrustedSystemStartupSession, UserSession, UtilityComponent, WebServiceLookupRule, XMLABaseComponent, XMLADataComponent, XMLALookupRule, XQueryBaseComponent, XQueryLookupRule

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

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

Method Detail

getObjectName

java.lang.String getObjectName()

Returns the Java class name for this object.

Returns:

the name of the object (the Java class name)

getProcessId

java.lang.String getProcessId()

Return the id for the execution of a given action sequence document.

Returns:

the process id

getActionName

java.lang.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

java.lang.String getId()

Returns a unique id (across classes and instances) for this auditable object.

Returns:

the auditable's id