de.xima.fc.plugin.abstracts

Class APluginCustomGUIBean

java.lang.Object

de.xima.fc.plugin.abstracts.APluginCustomGUIBean

All Implemented Interfaces:

IProcessingBean, IPluginCustomGUIBean, Serializable

public abstract class APluginCustomGUIBean
extends Object
implements IPluginCustomGUIBean, IProcessingBean, Serializable

Abstrakte Hilfsklasse für die Arbeit mit Custom Plugin-Oberflächen

Author:

xima media GmbH, Dresden

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
APluginCustomGUIBean()

Method Summary

Modifier and Type	Method and Description
IParameterModel	addNewParameter(String name) (non-Javadoc)
List<IParameterModel>	getAllParameter() (non-Javadoc)
Aktion	getCurrentAction() (non-Javadoc)
Locale	getCurrentLocale() (non-Javadoc)
Projekt	getCurrentProject() (non-Javadoc)
Status	getCurrentState() (non-Javadoc)
IEntityContext	getEntityContext() (non-Javadoc)
IPluginFileHelper	getFileHelper() (non-Javadoc)
List<IParameterModel>	getFilteredParameters() (non-Javadoc)
abstract Set<String>	getFilterForParameter() Liefert ein Set von Parameternamen, die aus der intern gehaltenen Plugin-Parameterliste herausgefiltert werden sollen, da sie in der Custom-Oberfläche eigenständig angezeigt und behandelt werden.
IParameterModel	getParameter(String paramName) (non-Javadoc)
IProcessingBean	getProcessingBean() (non-Javadoc)
Properties	getProperties() (non-Javadoc)
List<Aktion>	getProvidingPrevActions() (non-Javadoc)
IPluginResourceHelper	getResourceHelper() (non-Javadoc)
void	initialize(IPluginInitializeBeanData initializeBeanData) Method to initialize an plugin custom-ui bean
void	removeParameter(int idx) Entfernt Parameter am entsprechenden Index aus der Parameterliste
void	removeParameter(String paramName) (non-Javadoc)
void	setFilterForParameter(Set<String> filterParams) (non-Javadoc)
void	setProcessingBean(IProcessingBean bean) (non-Javadoc)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

afterSave, beforeDelete, beforeSave

Constructor Detail

APluginCustomGUIBean

public APluginCustomGUIBean()

Method Detail

getFilterForParameter

public abstract Set<String> getFilterForParameter()

Liefert ein Set von Parameternamen, die aus der intern gehaltenen Plugin-Parameterliste herausgefiltert werden sollen, da sie in der Custom-Oberfläche eigenständig angezeigt und behandelt werden.

Returns:

ein Set mit Parameternamen, welche aus der internen Plugin-Parameterliste herausgefiltert werden sollen oder null

initialize

public void initialize(IPluginInitializeBeanData initializeBeanData)
                throws FCPluginException

Description copied from interface: IPluginCustomGUIBean

Method to initialize an plugin custom-ui bean

Specified by:

initialize in interface IPluginCustomGUIBean

Parameters:

initializeBeanData - IPluginInitializeBeanData

Throws:

FCPluginException - on errors while initialization

setFilterForParameter

public void setFilterForParameter(Set<String> filterParams)

(non-Javadoc)

Specified by:

setFilterForParameter in interface IProcessingBean

See Also:

IProcessingBean.setFilterForParameter(java.util.Set)

setProcessingBean

public void setProcessingBean(IProcessingBean bean)

(non-Javadoc)

Specified by:

setProcessingBean in interface IPluginCustomGUIBean

Parameters:

bean - a object of type IProcessingBean

See Also:

IPluginCustomGUIBean.setProcessingBean(de.xima.fc.plugin.config.IProcessingBean)

getProcessingBean

public IProcessingBean getProcessingBean()

(non-Javadoc)

Specified by:

getProcessingBean in interface IPluginCustomGUIBean

Returns:

a objekt of type IProcessingBean or null

See Also:

IPluginCustomGUIBean.getProcessingBean()

getFilteredParameters

public List<IParameterModel> getFilteredParameters()

(non-Javadoc)

Specified by:

getFilteredParameters in interface IProcessingBean

Returns:

See Also:

IProcessingBean.getFilteredParameters()

getAllParameter

public List<IParameterModel> getAllParameter()

(non-Javadoc)

Specified by:

getAllParameter in interface IProcessingBean

Returns:

See Also:

IProcessingBean.getAllParameter()

getParameter

public IParameterModel getParameter(String paramName)

(non-Javadoc)

Specified by:

getParameter in interface IProcessingBean

Returns:

See Also:

IProcessingBean.getParameter(java.lang.String)

addNewParameter

public IParameterModel addNewParameter(String name)

(non-Javadoc)

Specified by:

addNewParameter in interface IProcessingBean

Returns:

das hinzugefügte IParameterModel

See Also:

IProcessingBean.addNewParameter(java.lang.String)

removeParameter

public void removeParameter(String paramName)

(non-Javadoc)

Specified by:

removeParameter in interface IProcessingBean

See Also:

IProcessingBean.removeParameter(java.lang.String)

removeParameter

public void removeParameter(int idx)

Entfernt Parameter am entsprechenden Index aus der Parameterliste

Parameters:

idx -

getProvidingPrevActions

public List<Aktion> getProvidingPrevActions()

(non-Javadoc)

Specified by:

getProvidingPrevActions in interface IProcessingBean

Returns:

See Also:

IProcessingBean.getProvidingPrevActions()

getCurrentProject

public Projekt getCurrentProject()

(non-Javadoc)

Specified by:

getCurrentProject in interface IProcessingBean

Returns:

Projekt

See Also:

IProcessingBean.getCurrentProject()

getCurrentState

public Status getCurrentState()

(non-Javadoc)

Specified by:

getCurrentState in interface IProcessingBean

Returns:

Status

See Also:

IProcessingBean.getCurrentState()

getEntityContext

public IEntityContext getEntityContext()

(non-Javadoc)

Specified by:

getEntityContext in interface IProcessingBean

Returns:

IEntityContext

See Also:

IProcessingBean.getEntityContext()

getCurrentAction

public Aktion getCurrentAction()

(non-Javadoc)

Specified by:

getCurrentAction in interface IProcessingBean

Returns:

See Also:

IProcessingBean.getEntityContext()

getCurrentLocale

public Locale getCurrentLocale()

(non-Javadoc)

Specified by:

getCurrentLocale in interface IProcessingBean

Returns:

See Also:

IProcessingBean.getEntityContext()

getProperties

public Properties getProperties()

(non-Javadoc)

Specified by:

getProperties in interface IPluginCustomGUIBean

Returns:

Properties

See Also:

IPluginCustomGUIBean.getProperties()

getFileHelper

public IPluginFileHelper getFileHelper()

(non-Javadoc)

Specified by:

getFileHelper in interface IPluginCustomGUIBean

Returns:

IPluginFileHelper

See Also:

IPluginCustomGUIBean.getFileHelper()

getResourceHelper

public IPluginResourceHelper getResourceHelper()

(non-Javadoc)

Specified by:

getResourceHelper in interface IPluginCustomGUIBean

Returns:

IPluginResourceHelper

See Also:

IPluginCustomGUIBean.getResourceHelper()