Package 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
@Deprecated public abstract class APluginCustomGUIBean extends APluginGenericCustomGUIBean implements IPluginCustomGUIBean, IProcessingBean
Deprecated.Use the new workflow engine, see e.g.IPluginWorkflowNode
.Helper class for a custom beans used by a processing plugin- Author:
- XIMA MEDIA GmbH
- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description APluginCustomGUIBean()
Deprecated.
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description IParameterModel
addNewParameter(String name)
Deprecated.Adds a new parameter to the list of parameters, and returns the newly createdIParameterModel
for that parameter.List<IParameterModel>
getAllParameter()
Deprecated.Returns the list of all parameters.Aktion
getCurrentAction()
Deprecated.Finds the currently selected workflow action.Locale
getCurrentLocale()
Deprecated.Finds the locale the current user is using.Projekt
getCurrentProject()
Deprecated.Finds the project to which the workflow action belongStatus
getCurrentState()
Deprecated.Finds the state to which the workflow action belongsIEntityContext
getEntityContext()
Deprecated.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)
Deprecated.Finds the parameter with the given name in the list of parametersIProcessingBean
getProcessingBean()
Deprecated.Provides access to the formcycle processing bean.List<Aktion>
getProvidingPrevActions()
Deprecated.Liefert eine Liste mit allen datei-bereitstellenden Aktionen, welche der aktuellen Aktion innerhalb des aktuellen Status vorgelagert sindvoid
initialize(IPluginInitializeBeanData initializeBeanData)
Deprecated.A callback method that is invoked after all beans required by theIPluginGenericCustomGUI
plugin were created.boolean
isNewWorkflow()
Deprecated.void
removeParameter(int idx)
Deprecated.Removes the parameter at the given index from the list of parameters.void
removeParameter(String paramName)
Deprecated.Removes the parameter with the given name from the list of parameters.void
setProcessingBean(IProcessingBean bean)
Deprecated.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
-
-
-
-
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.
-
isNewWorkflow
public boolean isNewWorkflow()
Deprecated.- Specified by:
isNewWorkflow
in interfaceIProcessingBean
-
initialize
public void initialize(IPluginInitializeBeanData initializeBeanData) throws FCPluginException
Deprecated.Description copied from interface:IPluginGenericCustomGUIBean
A callback method that is invoked after all beans required by theIPluginGenericCustomGUI
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 interfaceIPluginGenericCustomGUIBean
- Overrides:
initialize
in classAPluginGenericCustomGUIBean
- Parameters:
initializeBeanData
- TheIPluginInitializeBeanData
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)
Deprecated.Description copied from interface:IPluginCustomGUIBean
Sets a reference to the formcycle processing bean- Specified by:
setProcessingBean
in interfaceIPluginCustomGUIBean
- Parameters:
bean
- an object of typeIProcessingBean
-
getProcessingBean
public IProcessingBean getProcessingBean()
Deprecated.Description copied from interface:IPluginCustomGUIBean
Provides access to the formcycle processing bean.- Specified by:
getProcessingBean
in interfaceIPluginCustomGUIBean
- Returns:
- an object of type
IProcessingBean
or null
-
getAllParameter
public List<IParameterModel> getAllParameter()
Deprecated.Description copied from interface:IProcessingBean
Returns the list of all parameters.- Specified by:
getAllParameter
in interfaceIProcessingBean
- Returns:
- A
List
with a processing parameters.
-
getParameter
public IParameterModel getParameter(String paramName)
Deprecated.Description copied from interface:IProcessingBean
Finds the parameter with the given name in the list of parameters- Specified by:
getParameter
in interfaceIProcessingBean
- Parameters:
paramName
- Name of the parameter to get- Returns:
- The
IParameterModel
for the parameter, ornull
when no such parameter exists
-
addNewParameter
public IParameterModel addNewParameter(String name)
Deprecated.Description copied from interface:IProcessingBean
Adds a new parameter to the list of parameters, and returns the newly createdIParameterModel
for that parameter.- Specified by:
addNewParameter
in interfaceIProcessingBean
- Parameters:
name
- Name of the parameter to add- Returns:
- The newly created
IParameterModel
-
removeParameter
public void removeParameter(String paramName)
Deprecated.Description copied from interface:IProcessingBean
Removes the parameter with the given name from the list of parameters.- Specified by:
removeParameter
in interfaceIProcessingBean
- Parameters:
paramName
- Name of the parameter to remove
-
removeParameter
public void removeParameter(int idx)
Deprecated.Description copied from interface:IProcessingBean
Removes the parameter at the given index from the list of parameters.- Specified by:
removeParameter
in interfaceIProcessingBean
- Parameters:
idx
- 0-based index of the parameter to remove.
-
getProvidingPrevActions
public List<Aktion> getProvidingPrevActions()
Deprecated.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 interfaceIProcessingBean
- Returns:
- an list of actions which provides files
-
getCurrentProject
public Projekt getCurrentProject()
Deprecated.Description copied from interface:IProcessingBean
Finds the project to which the workflow action belong- Specified by:
getCurrentProject
in interfaceIProcessingBean
- Returns:
- The current
Projekt
-
getCurrentState
public Status getCurrentState()
Deprecated.Description copied from interface:IProcessingBean
Finds the state to which the workflow action belongs- Specified by:
getCurrentState
in interfaceIProcessingBean
- Returns:
- The current
Status
of the action
-
getEntityContext
public IEntityContext getEntityContext()
Deprecated.Description copied from interface:IProcessingBean
Finds the entity context that can be used to access the database.- Specified by:
getEntityContext
in interfaceIProcessingBean
- Returns:
- A
IEntityContext
for the database
-
getCurrentAction
public Aktion getCurrentAction()
Deprecated.Description copied from interface:IProcessingBean
Finds the currently selected workflow action.- Specified by:
getCurrentAction
in interfaceIProcessingBean
- Returns:
- The selected workflow action.
-
getCurrentLocale
public Locale getCurrentLocale()
Deprecated.Description copied from interface:IProcessingBean
Finds the locale the current user is using.- Specified by:
getCurrentLocale
in interfaceIProcessingBean
- Returns:
- The current locale
-
-