de.xima.fc.plugin.gui

Interface IPluginCustomGUIBean

All Superinterfaces:

Serializable

All Known Implementing Classes:

APluginCustomGUIBean

public interface IPluginCustomGUIBean
extends Serializable

Interface for deploying the FORMCYCLE processing bean within a custom plugin bean

Author:

xima media GmbH, Dresden

Method Summary

Modifier and Type	Method and Description
default IPluginCustomGUIBeanAfterSave	afterSave() Functionality that is executed immediately after saving the plugin configuration in the ui
default IPluginCustomGUIBeanBeforeDelete	beforeDelete() Functionality that is executed immediately before delete the plugin configuration in the ui.
default IPluginCustomGUIBeanBeforeSave	beforeSave() Functionality that is executed immediately before saving the plugin configuration in the ui
IPluginFileHelper	getFileHelper() Gets the helper-class for working with plugin-files
IProcessingBean	getProcessingBean() Provides access to the FORMCYCLE processing bean.
Properties	getProperties() Returns the properties of the plugin
IPluginResourceHelper	getResourceHelper() Gets the helper-class for working with resources
default void	initialize(IPluginInitializeBeanData initializeBeanData) Method to initialize an plugin custom-ui bean
void	setProcessingBean(IProcessingBean bean) Sets a reference to the FORMCYCLE processing bean

Method Detail

initialize

default void initialize(IPluginInitializeBeanData initializeBeanData)
                 throws FCPluginException

Method to initialize an plugin custom-ui bean

Parameters:

initializeBeanData - IPluginInitializeBeanData

Throws:

FCPluginException - on errors while initialization

getProperties

Properties getProperties()

Returns the properties of the plugin

Returns:

Properties

getFileHelper

IPluginFileHelper getFileHelper()

Gets the helper-class for working with plugin-files

Returns:

IPluginFileHelper

getResourceHelper

IPluginResourceHelper getResourceHelper()

Gets the helper-class for working with resources

Returns:

IPluginResourceHelper

setProcessingBean

void setProcessingBean(IProcessingBean bean)

Sets a reference to the FORMCYCLE processing bean

Parameters:

bean - a object of type IProcessingBean

getProcessingBean

IProcessingBean getProcessingBean()

Provides access to the FORMCYCLE processing bean.

Returns:

a objekt of type IProcessingBean or null

beforeSave

default IPluginCustomGUIBeanBeforeSave beforeSave()

Functionality that is executed immediately before saving the plugin configuration in the ui

Returns:

if true is returned, plugin will be saved, else not

afterSave

default IPluginCustomGUIBeanAfterSave afterSave()

Functionality that is executed immediately after saving the plugin configuration in the ui

beforeDelete

default IPluginCustomGUIBeanBeforeDelete beforeDelete()

Functionality that is executed immediately before delete the plugin configuration in the ui. Can be used for clean up functionality before deletion the action plugin from workflow-processing.