Package org.pentaho.platform.api.engine
Interface IPentahoPublisher
public interface IPentahoPublisher
Defines the interface for getting objects published in the platform. Publishers are defined in the pentaho.xml,
and show up on the console in the Publish jsp.
- Author:
- mbatchel
- See Also:
-
SolutionPublisher
SettingsPublisher
-
Method Summary
Modifier and TypeMethodDescriptiongetName()
publish
(IPentahoSession session, int loggingLevel) Called when the publish is requested.
-
Method Details
-
publish
Called when the publish is requested.- Parameters:
session
- The session of the requesterloggingLevel
- Log granularity level- Returns:
- message indicating success or failure. This message is shown back to the user that requested the publish.
-
getName
String getName()- Returns:
- The name of the publisher. This name is displayed in the Publish JSP
-
getDescription
String getDescription()- Returns:
- The description of the publisher. This string is displayed in the Publish JSP
-