IPentahoPublisher


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 Jul 13, 2005 
14   * @author James Dixon
15   * 
16   */
17  
18  package org.pentaho.core.publisher;
19  
20  import org.pentaho.core.session.IPentahoSession;
21  
22  /**
23   * Defines the interface for getting objects published in the platform. Publishers
24   * are defined in the pentaho.xml, and show up on the console in the Publish jsp.
25   * 
26   * @author mbatchel
27   * @see SolutionPublisher
28   * @see SettingsPublisher
29   *
30   */
31  
32  public interface IPentahoPublisher {
33  
34      /**
35       * Called when the publish is requested.
36       * @param session The session of the requester
37       * @param loggingLevel Log granularity level
38       * @return message indicating success or failure. This message
39       * is shown back to the user that requested the publish.
40       */
41      public String   publish(IPentahoSession session, int loggingLevel);
42  
43      /**
44       * @return The name of the publisher. This name is displayed in the Publish JSP
45       */
46      public String   getName();
47  
48      /**
49       * @return The description of the publisher. This string is displayed in the Publish JSP
50       */
51      public String   getDescription();
52  
53  }
54
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags