org.pentaho.platform.api.engine
Interface IPluginSettings

All Known Implementing Classes:

PluginSettings

public interface IPluginSettings

Author:

jamesdixon

Method Summary

IContentGenerator	getContentGenerator(String id, IPentahoSession session)
IContentGenerator	getContentGeneratorForType(String type, IPentahoSession session)
String	getContentGeneratorIdForType(String type, IPentahoSession session)
IContentGeneratorInfo	getContentGeneratorInfo(String id, IPentahoSession session)
List<IObjectCreator>	getContentGeneratorsForType(String type, IPentahoSession session) Returns a list of object factories that can be used to create content generators for a given type.
String	getContentGeneratorTitleForType(String type, IPentahoSession session)
String	getContentGeneratorUrlForType(String type, IPentahoSession session)
IContentInfo	getContentInfoFromExtension(String extension, IPentahoSession session)
Set<String>	getContentTypes() Returns a set of the content types that the registered plugins can process.
IContentGeneratorInfo	getDefaultContentGeneratorInfoForType(String type, IPentahoSession session)
List	getMenuCustomizations() Returns a list of menu customization objects.
boolean	updatePluginSettings(IPentahoSession session, List<String> comments) Causes the plugin settings object to re-register all of the plugins that are defined in pentaho-solutions/system/./plugin.xml files

Method Detail

getContentTypes

Set<String> getContentTypes()

Returns a set of the content types that the registered plugins can process. If the plugin is intended to handle the processing of a document in the solution repository the types need to match with the filename extension.

Returns:

getContentInfoFromExtension

IContentInfo getContentInfoFromExtension(String extension,
                                         IPentahoSession session)

getContentGeneratorsForType

List<IObjectCreator> getContentGeneratorsForType(String type,
                                                 IPentahoSession session)

Returns a list of object factories that can be used to create content generators for a given type. In most cases there will only be one content generator for any one type.

Parameters:

type -

session - A session used for storing objects from session-scoped factories

Returns:

List of IObjectCreator objects

getContentGenerator

IContentGenerator getContentGenerator(String id,
                                      IPentahoSession session)
                                      throws ObjectFactoryException

Throws:

ObjectFactoryException

getContentGeneratorInfo

IContentGeneratorInfo getContentGeneratorInfo(String id,
                                              IPentahoSession session)

getDefaultContentGeneratorInfoForType

IContentGeneratorInfo getDefaultContentGeneratorInfoForType(String type,
                                                            IPentahoSession session)

getContentGeneratorIdForType

String getContentGeneratorIdForType(String type,
                                    IPentahoSession session)

getContentGeneratorTitleForType

String getContentGeneratorTitleForType(String type,
                                       IPentahoSession session)

getContentGeneratorUrlForType

String getContentGeneratorUrlForType(String type,
                                     IPentahoSession session)

getContentGeneratorForType

IContentGenerator getContentGeneratorForType(String type,
                                             IPentahoSession session)
                                             throws ObjectFactoryException

Throws:

ObjectFactoryException

getMenuCustomizations

List getMenuCustomizations()

Returns a list of menu customization objects. Objects in this list will be org.pentaho.ui.xul.IMenuCustomization objects

Returns:

List of IMenuCustomization objects

updatePluginSettings

boolean updatePluginSettings(IPentahoSession session,
                             List<String> comments)

Causes the plugin settings object to re-register all of the plugins that are defined in pentaho-solutions/system/./plugin.xml files

Parameters:

session - A session to be used for getting the plugin.xml files

comments - A list of strings that readable messages will be added to as the plugins are processed.

Returns:

true if no errors were encountered