ProcessingBean (FORMCYCLE: BOM 6.5.0 API)

java.lang.Object
- de.xima.fc.gui.common.utils.msg.I18nUtils
- - de.xima.fc.gui.common.utils.msg.MessageUtils
  - - de.xima.fc.gui.common.utils.msg.AMessaging
    - - de.xima.fc.gui.common.utils.msg.AJSFContext
      - de.xima.fc.gui.bean.ABackendJSFContext
        
        de.xima.fc.gui.bean.FCContextBean
        
        de.xima.fc.gui.bean.workflow.ProcessingBean

All Implemented Interfaces:

IProcessingBean, Serializable
```
public class ProcessingBean
extends FCContextBean
implements IProcessingBean
```
Author:

XIMA MEDIA GmbH

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static interface`	`ProcessingBean.IActionSelectItem`
`class`	`ProcessingBean.PluginSelectItem`
`class`	`ProcessingBean.ProcessingSelectItem`

Nested classes/interfaces inherited from class de.xima.fc.gui.common.utils.msg.AJSFContext
AJSFContext.RedirectOptions, AJSFContext.RedirectOptionsBuilder

Field Summary

Fields
Modifier and Type	Field and Description
`protected ActionBean`	`actionBean`
`protected ClientResourceBean`	`clientResourceBean`
`protected CurrentProjectBean`	`currentProjectBean`
`protected ProjectResourceBean`	`projectResourceBean`
`protected StateBean`	`stateBean`

Fields inherited from class de.xima.fc.gui.bean.FCContextBean
systemUC

Constructor Summary

Constructors
Constructor and Description

ProcessingBean()

Constructors
Constructor and Description
`ProcessingBean()`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addNewParameter()`
`IParameterModel`	`addNewParameter(String name)` Adds a new parameter to the list of parameters, and returns the newly created `IParameterModel` for that parameter.
`void`	`copyCheckedNodes()`
`void`	`createNewProcessing(String selectedProcessing)`
`void`	`deleteCheckedNodes()`
`void`	`destroy()`
`ActionBean`	`getActionBean()`
`List<Long>`	`getActionIds()` Deprecated.
`List<String>`	`getActionUUIDs()`
`List<DatenbankZugriff>`	`getAllDatabaseConnections()` Liefert alle für den aktuellen Mandanten hinterlegten Datenbankzugriffe
`List<String>`	`getAllFormElements()` Liefert Liste mit allen Upload-Element der aktuell aktiven Formularversion
`List<Postfach>`	`getAllInboxes()` Methode zum Erhalt aller Postfächer vom aktuellen Mandanten
`List<IParameterModel>`	`getAllParameter()` Returns the list of all parameters.
`Set<IPluginProcessing>`	`getAllPlugins()` Liefert eine Liste mit allen verfügbaren Plugins
`List<Status>`	`getAllStatus()` Liefert alle Status eines Projektes zurück
`List<String>`	`getAllUploadElements()` Liefert Liste mit allen Upload-Element der aktuell aktiven Formularversion
`List<BenutzerGruppe>`	`getAllUserGroups()` Returns all `BenutzerGruppe` defined for the `Mandant`
`List<Benutzer>`	`getAllUsers()` Returns all `Benutzer` defined for the `Mandant`
`List<javax.faces.model.SelectItem>`	`getAvailableResources(boolean includeForm, boolean includeClient, boolean includeExternal)` Returns a list of all available resources, which may include client resources, form resources, and external resource URLs.
`List<javax.faces.model.SelectItem>`	`getAvailableResources(boolean includeForm, boolean includeClient, boolean includeExternal, String... extensions)` Returns a list of all available resources, which may include client resources, form resources, and external resource URLs.
`MandantRessource`	`getClientResource()`
`ClientResourceBean`	`getClientResourceBean()`
`IConsuming`	`getConsumingProcessing()`
`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
`CurrentProjectBean`	`getCurrentProjectBean()`
`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.
`List<Aktion>`	`getFollowActions()`
`Map<String,String>`	`getFormPlaceholder()`
`IGuiIcon`	`getIcon(Aktion action)`
`List<String>`	`getInstalledFontNameList()`
`List<javax.faces.model.SelectItem>`	`getListActions()`
`List<javax.faces.model.SelectItem>`	`getListPlugins()`
`IParameterModel`	`getParameter(String paramName)` Finds the parameter with the given name in the list of parameters
`List<String>`	`getPlaceholderList()` Liefert eine Liste mit Zeichenketten aller verfügbaren Platzhalter (Systemplatzhalter, Formularplatzhalter, Platzhalter aus WorkflowProcessingContext)
`List<String>`	`getPlaceholderListForCodeMirror(org.primefaces.extensions.event.CompleteEvent event)`
`String`	`getPluginConfigPage()` Liefert die anzuzeigende XHtml-Page für die Konfiguration von Plugins
`Map<String,IPluginCustomGUIBean>`	`getPluginCustomGUIBean()` Getter for `IPluginCustomGUIBean` object
`String`	`getPluginDescription()`
`String`	`getPluginNotAvailableMsg()`
`IProcessing`	`getProcessing()`
`IGuiIcon`	`getProcessingIcon(String processingKey)`
`String`	`getProcessingLabel(String processingKey)`
`IProcessingModel`	`getProcessingModel()`
`String`	`getProcessingPage()`
`List<javax.faces.model.SelectItem>`	`getProcessingTypes()`
`ProjektRessource`	`getProjectResource()`
`ProjectResourceBean`	`getProjectResourceBean()`
`List<Aktion>`	`getProvidingPrevActions()` Liefert eine Liste mit allen datei-bereitstellenden Aktionen, welche der aktuellen Aktion innerhalb des aktuellen Status vorgelagert sind
`String`	`getRedirectPreviewUrl()` Erzeugt den Vorschau-URL für Verarbeitungen vom Typ `VerarbeitungWeiterleitung`
`String`	`getSelectedProcessing()`
`StateBean`	`getStateBean()`
`List<Textbaustein>`	`getTextbausteineByKategorie(ETextbausteinKategorie kategorie)` Liefert Liste mit mandanten-spezifische Textbausteinen einer bestimmten Kategorie.
`List<String>`	`getUploadElements()`
`ViewEventBusBean`	`getViewEventBusBean()`
`void`	`init()`
`boolean`	`isPlugin(String processingKey)`
`boolean`	`isPluginSelected()`
`boolean`	`isShowEncryptionSelection()`
`void`	`onClose()`
`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`	`reset()`
`void`	`setActionBean(ActionBean actionBean)`
`void`	`setActionIds(List<Long> actionIds)` Deprecated.
`void`	`setActionUUIDs(List<String> uuids)`
`void`	`setClientResourceBean(ClientResourceBean clientResourceBean)`
`void`	`setCurrentProjectBean(CurrentProjectBean currentProjectBean)`
`void`	`setInstalledFontNameList(List<String> installedFontNameList)`
`void`	`setProjectResourceBean(ProjectResourceBean projectResourceBean)`
`void`	`setSelectedProcessing(String selectedProcessing)`
`void`	`setStateBean(StateBean stateBean)`
`void`	`setUploadElements(List<String> uploadElements)`
`void`	`setupNewProcessing()`
`void`	`setViewEventBusBean(ViewEventBusBean viewEventBusBean)`
`List<Charset>`	`supportedCharsets()`
`void`	`treeSelectionChanged()`
`void`	`updateConfigParameterList(javax.faces.event.AjaxBehaviorEvent evt)`

Methods inherited from class de.xima.fc.gui.bean.FCContextBean
getNavigationBean, getSessionBean, isSetupUser, redirectToDashboard, setNavigationBean, setSessionBean, switchMainView, switchMainView, switchSubView, switchSubView

Methods inherited from class de.xima.fc.gui.bean.ABackendJSFContext
ec, isDetached, isHasDB

Methods inherited from class de.xima.fc.gui.common.utils.msg.AJSFContext
destroySessionBean, encodeURL, findBean, findBean, findBean, findBean, findBean, findBean, findBean, findCurrentView, getBeanName, getBeanName, getContext, getCurrentViewBean, getLocaleBean, getRequest, getResponse, getSession, getSession, getSessionAttribute, isMasterServerContext, loadLazy, redirect, redirect, redirect, redirect, redirectToDashboard, redirectToDashboard, setLocaleBean, setSessionAttribute, uc

Methods inherited from class de.xima.fc.gui.common.utils.msg.I18nUtils
getFacesContext, getLocale, rbValue, rbValue, rbValue

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.config.IProcessingBean
getFilteredParameters, setFilterForParameter

- Field Detail
  - actionBean
```
protected ActionBean actionBean
```
  - stateBean
```
protected StateBean stateBean
```
  - currentProjectBean
```
protected CurrentProjectBean currentProjectBean
```
  - projectResourceBean
```
protected ProjectResourceBean projectResourceBean
```
  - clientResourceBean
```
protected ClientResourceBean clientResourceBean
```
- Constructor Detail
  - ProcessingBean
```
public ProcessingBean()
```
- Method Detail
  - init
```
@PostConstruct
public void init()
```
  - getProjectResourceBean
```
public ProjectResourceBean getProjectResourceBean()
```
  - setProjectResourceBean
```
public void setProjectResourceBean(ProjectResourceBean projectResourceBean)
```
  - getClientResourceBean
```
public ClientResourceBean getClientResourceBean()
```
  - setClientResourceBean
```
public void setClientResourceBean(ClientResourceBean clientResourceBean)
```
  - destroy
```
@PreDestroy
public void destroy()
```
  - getViewEventBusBean
```
public ViewEventBusBean getViewEventBusBean()
```
  - setViewEventBusBean
```
public void setViewEventBusBean(ViewEventBusBean viewEventBusBean)
```
  - getInstalledFontNameList
```
public List<String> getInstalledFontNameList()
```
  - setInstalledFontNameList
```
public void setInstalledFontNameList(List<String> installedFontNameList)
```
  - 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.
  - getSelectedProcessing
```
public String getSelectedProcessing()
```
  - setSelectedProcessing
```
public void setSelectedProcessing(String selectedProcessing)
```
  - createNewProcessing
```
public void createNewProcessing(String selectedProcessing)
```
  - isShowEncryptionSelection
```
public boolean isShowEncryptionSelection()
```
    Returns:
    
    Whether the user may select an encryption method for the email. When no methods are available, the select field is hidden.
  - getTextbausteineByKategorie
```
public List<Textbaustein> getTextbausteineByKategorie(ETextbausteinKategorie kategorie)
```
    Liefert Liste mit mandanten-spezifische Textbausteinen einer bestimmten Kategorie.
    
    Parameters:
    
    kategorie - Type of the templates to look for
    
    Returns:
    
    Liste mit Textbausteinen oder leere Liste.
  - getAllInboxes
```
public List<Postfach> getAllInboxes()
```
    Methode zum Erhalt aller Postfächer vom aktuellen Mandanten
    
    Returns:
    
    Liste mit allen Postfächern oder leere Liste
  - getAllStatus
```
public List<Status> getAllStatus()
```
    Liefert alle Status eines Projektes zurück
    
    Returns:
    
    Liste mit allen Status eines Projekts oder leere Liste
  - getAllDatabaseConnections
```
public List<DatenbankZugriff> getAllDatabaseConnections()
```
    Liefert alle für den aktuellen Mandanten hinterlegten Datenbankzugriffe
    
    Returns:
    
    Liste mit allen Datenbankzugriffen oder leere Liste
  - getAllUsers
```
public List<Benutzer> getAllUsers()
```
    Returns all Benutzer defined for the Mandant
    
    Returns:
    
    List of Benutzer
  - getAllUserGroups
```
public List<BenutzerGruppe> getAllUserGroups()
```
    Returns all BenutzerGruppe defined for the Mandant
    
    Returns:
    
    List of BenutzerGruppe
  - getAllUploadElements
```
public List<String> getAllUploadElements()
```
    Liefert Liste mit allen Upload-Element der aktuell aktiven Formularversion
    
    Returns:
    
    List of upload elements
  - getAllFormElements
```
public List<String> getAllFormElements()
```
    Liefert Liste mit allen Upload-Element der aktuell aktiven Formularversion
    
    Returns:
    
    List of all form elements
  - getAllPlugins
```
public Set<IPluginProcessing> getAllPlugins()
```
    Liefert eine Liste mit allen verfügbaren Plugins
    
    Returns:
    
    Set of all processing plugins
  - getPluginConfigPage
```
public String getPluginConfigPage()
```
    Liefert die anzuzeigende XHtml-Page für die Konfiguration von Plugins
    
    Returns:
    
    the path to the plugin config page
  - getPluginCustomGUIBean
```
public Map<String,IPluginCustomGUIBean> getPluginCustomGUIBean()
```
    Getter for IPluginCustomGUIBean object
    
    Returns:
    
    a IPluginCustomGUIBean object if exists, else null
  - updateConfigParameterList
```
public void updateConfigParameterList(javax.faces.event.AjaxBehaviorEvent evt)
```
  - getPluginDescription
```
public String getPluginDescription()
```
    Returns:
    
    eine Beschreibung oder null
  - getPlaceholderList
```
public List<String> getPlaceholderList()
```
    Liefert eine Liste mit Zeichenketten aller verfügbaren Platzhalter (Systemplatzhalter, Formularplatzhalter, Platzhalter aus WorkflowProcessingContext)
    
    Returns:
    
    Liste mit Platzhaltern
  - getPlaceholderListForCodeMirror
```
public List<String> getPlaceholderListForCodeMirror(org.primefaces.extensions.event.CompleteEvent event)
```
  - supportedCharsets
```
public List<Charset> supportedCharsets()
```
  - getRedirectPreviewUrl
```
public String getRedirectPreviewUrl()
```
    Erzeugt den Vorschau-URL für Verarbeitungen vom Typ VerarbeitungWeiterleitung
    
    Returns:
    
    preview url to redirect to
  - getActionIds
```
@Deprecated
public List<Long> getActionIds()
```
    Deprecated.
    
    Returns:
    
    The selected action IDs for the current processing. Action IDs that do not exist anymore or that refer to actions that are not placed before the current action are filtered out.
  - getUploadElements
```
public List<String> getUploadElements()
```
  - getAvailableResources
```
public List<javax.faces.model.SelectItem> getAvailableResources(boolean includeForm,
                                                                boolean includeClient,
                                                                boolean includeExternal)
```
    Returns a list of all available resources, which may include client resources, form resources, and external resource URLs.
    
    Parameters:
    
    includeForm - Whether to include the available form resources.
    
    includeClient - Whether to include the available client resources.
    
    includeExternal - Whether to include an option for entering an external resource URL.
    
    Returns:
    
    A list of all available resources (files).
  - getAvailableResources
```
public List<javax.faces.model.SelectItem> getAvailableResources(boolean includeForm,
                                                                boolean includeClient,
                                                                boolean includeExternal,
                                                                String... extensions)
```
    Returns a list of all available resources, which may include client resources, form resources, and external resource URLs.
    
    Parameters:
    
    includeForm - Whether to include the available form resources.
    
    includeClient - Whether to include the available client resources.
    
    includeExternal - Whether to include an option for entering an external resource URL.
    
    extensions - A list of extensions for filtering the returned resources. When no extensions are given, no filtering is applied.
    
    Returns:
    
    A list of all available resources. Only resources with the given extensions are returned.
  - setUploadElements
```
public void setUploadElements(List<String> uploadElements)
```
  - setActionIds
```
@Deprecated
public void setActionIds(List<Long> actionIds)
```
    Deprecated.
  - setActionUUIDs
```
public void setActionUUIDs(List<String> uuids)
```
  - getActionUUIDs
```
public List<String> getActionUUIDs()
```
  - 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
  - getFollowActions
```
public List<Aktion> getFollowActions()
```
  - getFormPlaceholder
```
public Map<String,String> getFormPlaceholder()
```
  - getProjectResource
```
public ProjektRessource getProjectResource()
```
  - getClientResource
```
public MandantRessource getClientResource()
```
  - getProcessingModel
```
public IProcessingModel getProcessingModel()
```
  - getProcessing
```
public IProcessing getProcessing()
```
  - getConsumingProcessing
```
public IConsuming getConsumingProcessing()
```
  - getStateBean
```
public StateBean getStateBean()
```
  - setStateBean
```
public void setStateBean(StateBean stateBean)
```
  - getActionBean
```
public ActionBean getActionBean()
```
  - setActionBean
```
public void setActionBean(ActionBean actionBean)
```
  - getCurrentProjectBean
```
public CurrentProjectBean getCurrentProjectBean()
```
  - setCurrentProjectBean
```
public void setCurrentProjectBean(CurrentProjectBean currentProjectBean)
```
  - getPluginNotAvailableMsg
```
public String getPluginNotAvailableMsg()
```
  - 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.
  - addNewParameter
```
public void addNewParameter()
```
  - 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
  - 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
  - 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.
  - isPluginSelected
```
public boolean isPluginSelected()
```
  - isPlugin
```
public boolean isPlugin(String processingKey)
```
  - getProcessingIcon
```
public IGuiIcon getProcessingIcon(String processingKey)
```
  - getIcon
```
public IGuiIcon getIcon(Aktion action)
```
  - getProcessingLabel
```
public String getProcessingLabel(String processingKey)
```
  - treeSelectionChanged
```
public void treeSelectionChanged()
```
  - deleteCheckedNodes
```
public void deleteCheckedNodes()
```
  - copyCheckedNodes
```
public void copyCheckedNodes()
```
  - reset
```
public void reset()
```
  - onClose
```
public void onClose()
```
  - setupNewProcessing
```
public void setupNewProcessing()
```
  - getProcessingTypes
```
public List<javax.faces.model.SelectItem> getProcessingTypes()
```
  - getListActions
```
public List<javax.faces.model.SelectItem> getListActions()
```
  - getListPlugins
```
public List<javax.faces.model.SelectItem> getListPlugins()
```
  - getProcessingPage
```
public String getProcessingPage()
```
  - 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
  - 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

Class ProcessingBean

Nested Class Summary

Nested classes/interfaces inherited from class de.xima.fc.gui.common.utils.msg.AJSFContext

Field Summary

Fields inherited from class de.xima.fc.gui.bean.FCContextBean

Constructor Summary

Method Summary

Methods inherited from class de.xima.fc.gui.bean.FCContextBean

Methods inherited from class de.xima.fc.gui.bean.ABackendJSFContext

Methods inherited from class de.xima.fc.gui.common.utils.msg.AJSFContext

Methods inherited from class de.xima.fc.gui.common.utils.msg.MessageUtils

Methods inherited from class de.xima.fc.gui.common.utils.msg.I18nUtils

Methods inherited from class java.lang.Object

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

Field Detail

actionBean

stateBean

currentProjectBean

projectResourceBean

clientResourceBean

Constructor Detail

ProcessingBean

Method Detail

init

getProjectResourceBean

setProjectResourceBean

getClientResourceBean

setClientResourceBean

destroy

getViewEventBusBean

setViewEventBusBean

getInstalledFontNameList

setInstalledFontNameList

getCurrentAction

getSelectedProcessing

setSelectedProcessing

createNewProcessing

isShowEncryptionSelection

getTextbausteineByKategorie

getAllInboxes

getAllStatus

getAllDatabaseConnections

getAllUsers

getAllUserGroups

getAllUploadElements

getAllFormElements

getAllPlugins

getPluginConfigPage

getPluginCustomGUIBean

updateConfigParameterList

getPluginDescription

getPlaceholderList

getPlaceholderListForCodeMirror

supportedCharsets

getRedirectPreviewUrl

getActionIds

getUploadElements

getAvailableResources

getAvailableResources

setUploadElements

setActionIds

setActionUUIDs

getActionUUIDs

getProvidingPrevActions

getFollowActions

getFormPlaceholder

getProjectResource

getClientResource

getProcessingModel

getProcessing

getConsumingProcessing

getStateBean

setStateBean

getActionBean

setActionBean

getCurrentProjectBean

setCurrentProjectBean

getPluginNotAvailableMsg

getAllParameter

addNewParameter