de.xima.fc.plugin.abstracts

Class APluginCustomGUIBean

java.lang.Object

de.xima.fc.plugin.abstracts.APluginGenericCustomGUIBean

de.xima.fc.plugin.abstracts.APluginCustomGUIBean

All Implemented Interfaces:

IProcessingBean, IPluginCustomGUIBean, IPluginGenericCustomGUIBean, Serializable

public abstract class APluginCustomGUIBean
extends APluginGenericCustomGUIBean
implements IPluginCustomGUIBean, IProcessingBean

Helper class for a custom beans used by a processing plugin

Author:

XIMA MEDIA GmbH

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
APluginCustomGUIBean()

Method Summary

Modifier and Type	Method and Description
IParameterModel	addNewParameter(String name) Adds a new parameter to the list of parameters, and returns the newly created IParameterModel for that parameter.
List<IParameterModel>	getAllParameter() Returns the list of all parameters.
Aktion	getCurrentAction() Finds the currently selected workflow action.
Locale	getCurrentLocale() Finds the locale the current user is using.
Projekt	getCurrentProject() Finds the project to which the workflow action belong
Status	getCurrentState() Finds the state to which the workflow action belongs
IEntityContext	getEntityContext() Finds the entity context that can be used to access the database.
Set<String>	getFilterForParameter() Deprecated. If you want to include a list of parameters in the UI and filter out some attributes, implement the filter yourself.
IParameterModel	getParameter(String paramName) Finds the parameter with the given name in the list of parameters
IProcessingBean	getProcessingBean() Provides access to the FORMCYCLE processing bean.
List<Aktion>	getProvidingPrevActions() Liefert eine Liste mit allen datei-bereitstellenden Aktionen, welche der aktuellen Aktion innerhalb des aktuellen Status vorgelagert sind
void	initialize(IPluginInitializeBeanData initializeBeanData) A callback method that is invoked after all beans required by the IPluginGenericCustomGUI plugin were created.
void	removeParameter(int idx) Removes the parameter at the given index from the list of parameters.
void	removeParameter(String paramName) Removes the parameter with the given name from the list of parameters.
void	setProcessingBean(IProcessingBean bean) Sets a reference to the FORMCYCLE processing bean

Methods inherited from class de.xima.fc.plugin.abstracts.APluginGenericCustomGUIBean

getFileHelper, getProperties, getResourceHelper

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

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

destroy, getFileHelper, getProperties, getResourceHelper

Methods inherited from interface de.xima.fc.plugin.config.IProcessingBean

getFilteredParameters, setFilterForParameter

Constructor Detail

APluginCustomGUIBean

public APluginCustomGUIBean()

Method Detail

getFilterForParameter

@Deprecated
public Set<String> getFilterForParameter()

Deprecated. If you want to include a list of parameters in the UI and filter out some attributes, implement the filter yourself.

This method is a stub that always returns an empty list.

initialize

public void initialize(IPluginInitializeBeanData initializeBeanData)
                throws FCPluginException

Description copied from interface: IPluginGenericCustomGUIBean

A callback method that is invoked after all beans required by the IPluginGenericCustomGUI plugin were created. You can use this method to get access to the plugin configuration data. If you need to perform any initialization logic, do it in this method.

Specified by:

initialize in interface IPluginGenericCustomGUIBean

Overrides:

initialize in class APluginGenericCustomGUIBean

Parameters:

initializeBeanData - The IPluginInitializeBeanData you can make use of in the initialization process.

Throws:

FCPluginException - When the bean could not be initialized. If you do throw the exception, an error will be shown to the user. Depending on the type of custom UI, the user may instead see an error page, a default page or be redirected to another page.

setProcessingBean

public void setProcessingBean(IProcessingBean bean)

Description copied from interface: IPluginCustomGUIBean

Sets a reference to the FORMCYCLE processing bean

Specified by:

setProcessingBean in interface IPluginCustomGUIBean

Parameters:

bean - an object of type IProcessingBean

getProcessingBean

public IProcessingBean getProcessingBean()

Description copied from interface: IPluginCustomGUIBean

Provides access to the FORMCYCLE processing bean.

Specified by:

getProcessingBean in interface IPluginCustomGUIBean

Returns:

an object of type IProcessingBean or null

getAllParameter

public List<IParameterModel> getAllParameter()

Description copied from interface: IProcessingBean

Returns the list of all parameters.

Specified by:

getAllParameter in interface IProcessingBean

Returns:

A List with a processing parameters.

getParameter

public IParameterModel getParameter(String paramName)

Description copied from interface: IProcessingBean

Finds the parameter with the given name in the list of parameters

Specified by:

getParameter in interface IProcessingBean

Parameters:

paramName - Name of the parameter to get

Returns:

The IParameterModel for the parameter, or null when no such parameter exists

addNewParameter

public IParameterModel addNewParameter(String name)

Description copied from interface: IProcessingBean

Adds a new parameter to the list of parameters, and returns the newly created IParameterModel for that parameter.

Specified by:

addNewParameter in interface IProcessingBean

Parameters:

name - Name of the parameter to add

Returns:

The newly created IParameterModel

removeParameter

public void removeParameter(String paramName)

Description copied from interface: IProcessingBean

Removes the parameter with the given name from the list of parameters.

Specified by:

removeParameter in interface IProcessingBean

Parameters:

paramName - Name of the parameter to remove

removeParameter

public void removeParameter(int idx)

Description copied from interface: IProcessingBean

Removes the parameter at the given index from the list of parameters.

Specified by:

removeParameter in interface IProcessingBean

Parameters:

idx - 0-based index of the parameter to remove.

getProvidingPrevActions

public List<Aktion> getProvidingPrevActions()

Description copied from interface: IProcessingBean

Liefert eine Liste mit allen datei-bereitstellenden Aktionen, welche der aktuellen Aktion innerhalb des aktuellen Status vorgelagert sind

Specified by:

getProvidingPrevActions in interface IProcessingBean

Returns:

an list of actions which provides files

getCurrentProject

public Projekt getCurrentProject()

Description copied from interface: IProcessingBean

Finds the project to which the workflow action belong

Specified by:

getCurrentProject in interface IProcessingBean

Returns:

The current Projekt

getCurrentState

public Status getCurrentState()

Description copied from interface: IProcessingBean

Finds the state to which the workflow action belongs

Specified by:

getCurrentState in interface IProcessingBean

Returns:

The current Status of the action

getEntityContext

public IEntityContext getEntityContext()

Description copied from interface: IProcessingBean

Finds the entity context that can be used to access the database.

Specified by:

getEntityContext in interface IProcessingBean

Returns:

A IEntityContext for the database

getCurrentAction

public Aktion getCurrentAction()

Description copied from interface: IProcessingBean

Finds the currently selected workflow action.

Specified by:

getCurrentAction in interface IProcessingBean

Returns:

The selected workflow action.

getCurrentLocale

public Locale getCurrentLocale()

Description copied from interface: IProcessingBean

Finds the locale the current user is using.

Specified by:

getCurrentLocale in interface IProcessingBean

Returns:

The current locale