Package de.xima.fc.plugin.gui

Interface IPluginCustomGUIBean

All Superinterfaces:

IPluginGenericCustomGUIBean, Serializable

All Known Implementing Classes:

APluginCustomGUIBean

public interface IPluginCustomGUIBean
extends IPluginGenericCustomGUIBean

Interface for deploying the FORMCYCLE processing bean within a custom plugin bean This bean must be view scoped, ie. have the ViewScoped annotation set. The bean is created when the plugin action is selected, and destroyed when a different action is selected.

Author:

XIMA MEDIA GmbH

Method Summary

Modifier and Type	Method	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
IProcessingBean	getProcessingBean()	Deprecated. Use a ManagedProperty with processingBean.
void	setProcessingBean(IProcessingBean bean)	Deprecated. Use a ManagedProperty with processingBean.

Methods inherited from interface de.xima.fc.plugin.gui.IPluginGenericCustomGUIBean

destroy, getFileHelper, getProperties, getResourceHelper, initialize

Method Detail

setProcessingBean

@Deprecated
void setProcessingBean(IProcessingBean bean)

Deprecated.

Use a ManagedProperty with processingBean. Otherwise, the processing bean will not be available when IPluginGenericCustomGUIBean.initialize(de.xima.fc.interfaces.plugin.lifecycle.IPluginInitializeBeanData) is called.

Sets a reference to the FORMCYCLE processing bean

Parameters:

bean - an object of type IProcessingBean

getProcessingBean

@Deprecated
IProcessingBean getProcessingBean()

Deprecated.

Use a ManagedProperty with processingBean. Otherwise, the processing bean will not be available when IPluginGenericCustomGUIBean.initialize(de.xima.fc.interfaces.plugin.lifecycle.IPluginInitializeBeanData) is called.

Provides access to the FORMCYCLE processing bean.

Returns:

an object 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.