KickJava   Java API By Example, From Geeks To Geeks.

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


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 Jun 24, 2005
14  * @author Marc Batchelor
15  */

16
17 package org.pentaho.core.audit;
18
19 import java.math.BigDecimal JavaDoc;
20
21 /**
22  * An implementation of the IAuditEntry interface describes the method by which
23  * audit messages are recorded and what destination storage they are recorded
24  * to.
25  */

26 public interface IAuditEntry {
27
28     /**
29      * This method will save the information passed as parameters to the audit
30      * storage location. One call to this method represents one entry in the
31      * audit system.
32      *
33      * @param jobId
34      * the id that ties together audit messages from the same
35      * execution
36      * @param instId
37      * id to be handed to the runtime repository
38      * @param objId
39      * the unique id for this instance of this object
40      * @param objType
41      * class name of the component that is being audited
42      * @param actor
43      * the username associated with the session this auditEntry is
44      * requested in
45      * @param messageType
46      * the messageType as defined in the MessageType constants class
47      * @param messageName
48      * @param messageTxtValue
49      * @param messageNumValue
50      * @param duration
51      * @throws AuditException
52      * @see org.pentaho.core.audit.MessageTypes
53      */

54     public void auditAll(String JavaDoc jobId, String JavaDoc instId, String JavaDoc objId, String JavaDoc objType, String JavaDoc actor, String JavaDoc messageType, String JavaDoc messageName, String JavaDoc messageTxtValue, BigDecimal JavaDoc messageNumValue, BigDecimal JavaDoc duration) throws AuditException;
55
56 }
57
Popular Tags