KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > pentaho > core > audit > IAuditable


1 /*
2  * Copyright 2006 Pentaho Corporation. All rights reserved.
3  * This software was developed by Pentaho Corporation and is provided under the terms
4  * of the Mozilla Public License, Version 1.1, or any later version. You may not use
5  * this file except in compliance with the license. If you need a copy of the license,
6  * please go to http://www.mozilla.org/MPL/MPL-1.1.txt. The Original Code is the Pentaho
7  * BI Platform. The Initial Developer is Pentaho Corporation.
8  *
9  * Software distributed under the Mozilla Public License is distributed on an "AS IS"
10  * basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. Please refer to
11  * the license for the specific language governing your rights and limitations.
12  *
13  * @created Apr 15, 2005
14  * @author Marc Batchelor
15  */
16
17 package org.pentaho.core.audit;
18
19 /**
20  * Any subsystem that implements the IAuditable interface is candidate for
21  * auditing within the platform. This interface outlines the necessary pieces of
22  * information that an object must be able to return in order to be auditable.
23  */
24 public interface IAuditable {
25
26     /**
27      * Returns the Java class name for this object.
28      *
29      * @return the name of the object (the Java class name)
30      */
31     public String JavaDoc getObjectName();
32
33     /**
34      * Return the id for the execution of a given action sequence document.
35      *
36      * @return the process id
37      */
38     public String JavaDoc getProcessId();
39
40     /**
41      * Return the name of the action sequence. Today, that name is synonymous
42      * with the name of the action sequence document in the solution repository.
43      *
44      * @return the name of the action sequence
45      */
46     public String JavaDoc getActionName();
47
48     /**
49      * Returns a unique id (across classes and instances) for this auditable
50      * object.
51      *
52      * @return the auditable's id
53      */
54     public String JavaDoc getId();
55
56 }
57
Popular Tags