Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Table of Contents

Abstract Class

  • org.joget.plugin.base.ExtDefaultPlugin
  • Under wflow-plugin-base module
  • A base abstract class that must be extended by every plugins

Method Detail

Abstract Methods

 

getName
public java.lang.String getName()

Return a unique name for the plugin. You can override a existing System plugin by providing the same name as the System plugin.

 

getVersion
public java.lang.String getVersion()

Return plugin version.

getDescription
public java.lang.String getDescription()

Return plugin description. This value will be used when a Resource Bundle Message Key "plugin.className.pluginDesc" is not found by getI18nDescription method.

Overridable Methods

getI18nLabel
public java.lang.String getI18nLabel()

Return a plugin description for the plugin based on language setting. It will auto look for Resource Bundle Message Key "plugin.className.pluginLabel"

getI18nDescription

Utility Methods

getProperties
setProperties
getProperty
setProperty
getPropertyString
start
stop 

Deprecated Methods

getPluginProperties
public org.joget.plugin.base.PluginProperty[] getPluginProperties()

Return a set of plugin properties to configure by admin user.

Deprecated Since version 3, Joget Workflow introduced a better UI for plugin configuration. A plugin should implement org.joget.plugin.property.model.PropertyEditable interface to provide the plugin configuration options.

execute
public java.lang.Object execute(java.util.Map properties)

To execute a plugin

Deprecated This method is only use by Process Tool plugin therefore it had been moved to org.joget.plugin.base.DefaultApplicationPlugin

Interface

  • org.joget.plugin.property.model.PropertyEditable
  • Under wflow-plugin-base module
  • A interface that must be implemented by a plugin to provide admin interface to configure the plugin

Method Detail

Interface Methods

getLabel
getClassName
getPropertyOptions
getProperties
setProperties
getProperty
getPropertyString
setProperty