org.pentaho.platform.api.engine
Interface IPentahoPublisher

All Known Implementing Classes:

BasePublisher, CleanRepoPublisher, GlobalListsPublisher, MetadataPublisher, MondrianCachePublisher, PluginAdapter, SettingsPublisher, SolutionPublisher, SubscriptionPublisher

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

java.lang.String	getDescription()
java.lang.String	getName()
java.lang.String	publish(IPentahoSession session, int loggingLevel) Called when the publish is requested.

Method Detail

publish

java.lang.String publish(IPentahoSession session,
                         int loggingLevel)

Called when the publish is requested.

Parameters:

session - The session of the requester

loggingLevel - Log granularity level

Returns:

message indicating success or failure. This message is shown back to the user that requested the publish.

getName

java.lang.String getName()

Returns:

The name of the publisher. This name is displayed in the Publish JSP

getDescription

java.lang.String getDescription()

Returns:

The description of the publisher. This string is displayed in the Publish JSP