View Javadoc

1   /**
2    * Copyright 2005-2006 the original author or authors.
3    *
4    * Licensed under the Gnu General Pubic License, Version 2.0 (the
5    * "License"); you may not use this file except in compliance with
6    * the License. You may obtain a copy of the License at
7    *
8    *      http://www.opensource.org/licenses/gpl-license.php
9    *
10   * This program is distributed in the hope that it will be useful,
11   * but WITHOUT ANY WARRANTY; without even the implied warranty of
12   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
13   * See the Gnu General Public License for more details.
14   */
15  package org.figure8.join.services.scripting;
16  
17  import java.util.List;
18  /**
19   * This is the interface definition of an accessor to script execution logs.
20   * @author <a href="mailto:laurent.broudoux@free.fr">Laurent Broudoux</a>
21   * @version $Revision: 1.2 $
22   */
23  public interface ScriptLogAccessor{
24  
25     // Public -------------------------------------------------------------------
26  
27     /**
28      * Save a ScriptLogInfo (indeed a create or update method)
29      * @param logInfo The ScriptLogInfo object to save
30      */
31     public abstract void saveScriptLogInfo(ScriptLogInfo logInfo);
32  
33     /**
34      * Retrieve all the info beans on available script logs for given entity
35      * @param entityId The id of entity to retrieve ScriptLogInfo objects for
36      * @param entityClass The class of entity to retrieve ScriptLogInfo objects for
37      * @return A list of {@link org.figure8.join.services.scripting.ScriptLogInfo} available for entity
38      */
39     public abstract List getScriptLogInfos(long entityId, String entityClass);
40  
41     /**
42      * Get all the info beans on available script logs for script having this name and category
43      * @param scriptName The name of the script to retrieve log for
44      * @param scriptCategory The category of the script to retrive log for
45      * @return A list of {@link org.figure8.join.services.scripting.ScriptLogInfo} available for script
46      */
47     public abstract List getScriptLogInfos(String scriptName, String scriptCategory);
48  }