ITriggerPropertiesBean (FORMCYCLE: BOM 7.0.13 API)

Type Parameters:

TData - Type of the properties model, see ITriggerHandler.

All Superinterfaces:

IElementPropertiesBean<TData,WorkflowTrigger>, Serializable

All Known Subinterfaces:

ITriggerPropertyPluginBean<TData>

All Known Implementing Classes:

FcStateTimerBean, FcTimePointBean
```
public interface ITriggerPropertiesBean<TData>
extends IElementPropertiesBean<TData,WorkflowTrigger>
```
The interface of a bean for editing the properties of workflow triggers. Each workflow trigger has got an event name, and for each kind a handler is registered. Each trigger handler may use a different bean.

Since:

7.0.0

Author:

XIMA MEDIA GmbH

Method Summary

All Methods Instance Methods Default Methods
Modifier and Type	Method	Description
`default IRetrieveElementPropsRetVal<TData>`	`retrieveCurrentProperties(TData storedModel)`	Called each time the data that is currently being edited needs to be retrieved, and possibly persisted.

Methods inherited from interface de.xima.fc.interfaces.workflow.elements.IElementPropertiesBean
prepareViewForElement, updateCurrentProperties, updateCurrentTask

- Method Detail
  - retrieveCurrentProperties
```
default IRetrieveElementPropsRetVal<TData> retrieveCurrentProperties(TData storedModel)
```
    Description copied from interface: IElementPropertiesBean
    
    Called each time the data that is currently being edited needs to be retrieved, and possibly persisted. Usually this is called when the user switch to another workflow element, or when the
    Note, however, that you may not assume the editing process for the current workflow element is done. The data is sometimes retrieved while the user is still editing the properties, such as to sync the properties with the workflow design area. Do not perform any clean up work here. Use PreDestroy for cleanup.
    
    Specified by:
    
    retrieveCurrentProperties in interface IElementPropertiesBean<TData,WorkflowTrigger>
    
    Parameters:
    
    storedModel - The same model that was passed to IElementPropertiesBean.prepareViewForElement(IElementPropInitParams). If you did not need to replace that model with another instance, you can just returned it. Conversely, if you did store the properties model in your bean, you may just return your stored value and ignore this parameter altogether.
    
    Returns:
    
    The current properties that reflect the current user input. You may mutate and return the same object(s) that were passed to IElementPropertiesBean.prepareViewForElement(IElementPropInitParams).