Package de.xima.fc.workflow.designer.bean.nodes

Class FcChangeStateBean

java.lang.Object

de.xima.fc.workflow.designer.bean.nodes.FcChangeStateBean

All Implemented Interfaces:

IElementPropertiesBean<FcChangeStateProps,WorkflowNode>, INodePropertiesBean<FcChangeStateProps>, Serializable

@ViewScoped
@Named
public class FcChangeStateBean
extends Object
implements INodePropertiesBean<FcChangeStateProps>

Bean for editing the properties of a EWorkflowNodeType.FC_CHANGE_STATE action in the workflow designer.

Since:

7.0.0

Author:

XIMA MEDIA GmbH

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
FcChangeStateBean()

Method Summary

Modifier and Type	Method	Description
void	applyEndUserStatePreset(EEndUserStatePreset preset)	Applies the given preset to the current end user state configuration.
List<javax.faces.model.SelectItem>	getAvailableEndUserStateIcons()
List<BaseConfigViewModel>	getOrderableAuthenticatorConfigs()
List<String>	getPermittedPersonGroupsDescriptions()	Returns a list of descriptions of all the person groups that are permitted to view the project.
EndUserStateConfigViewModel	getPortalConfig()	Gets the view model with settings for the state that are related to the user portal.
WorkflowStateModel	getState()
boolean	isShowEndUserStateConfiguration()	Whether to show the end user state configuration UI.
void	onChange(String property)	Callback invoked when a property of the state being edited was changed.
void	prepareViewForElement(IElementPropInitParams<FcChangeStateProps> params)	Called each time when the properties panel for a certain workflow element is loaded.
IRetrieveElementPropsRetVal<FcChangeStateProps>	retrieveCurrentProperties(FcChangeStateProps storedModel)	Called each time the data that is currently being edited needs to be retrieved, and possibly persisted.

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.interfaces.workflow.elements.IElementPropertiesBean

updateCurrentProperties, updateCurrentTask

Constructor Detail

FcChangeStateBean

public FcChangeStateBean()

Method Detail

applyEndUserStatePreset

public void applyEndUserStatePreset(EEndUserStatePreset preset)

Applies the given preset to the current end user state configuration. Overwrites existing values.

Parameters:

preset - The preset to apply.

getOrderableAuthenticatorConfigs

public List<BaseConfigViewModel> getOrderableAuthenticatorConfigs()

getAvailableEndUserStateIcons

public List<javax.faces.model.SelectItem> getAvailableEndUserStateIcons()

getPermittedPersonGroupsDescriptions

public List<String> getPermittedPersonGroupsDescriptions()

Returns a list of descriptions of all the person groups that are permitted to view the project.

Returns:

a list of descriptions of all the person groups that are permitted to view the project.

getState

public WorkflowStateModel getState()

Returns:

The current workflow state that is to be edited in the properties panel.

getPortalConfig

public EndUserStateConfigViewModel getPortalConfig()

Gets the view model with settings for the state that are related to the user portal.

Returns:

The current workflow state that is to be edited in the properties panel.

isShowEndUserStateConfiguration

public boolean isShowEndUserStateConfiguration()

Whether to show the end user state configuration UI.

Returns:

Whether to show the end user state configuration UI.

onChange

public void onChange(String property)

Callback invoked when a property of the state being edited was changed.

Parameters:

property - Property that was modified.

prepareViewForElement

public void prepareViewForElement(IElementPropInitParams<FcChangeStateProps> params)
                           throws Exception

Description copied from interface: IElementPropertiesBean

Called each time when the properties panel for a certain workflow element is loaded. This method is passed the workflow element and the properties model, and should perform whatever initialization is necessary in order for the user to start editing the properties.

Specified by:

prepareViewForElement in interface IElementPropertiesBean<FcChangeStateProps,WorkflowNode>

Parameters:

params - The current element to be edited and its properties. You may store a reference to these, modify them, and return them when IElementPropertiesBean.retrieveCurrentProperties(Object) is called.

Throws:

Exception - When the initialization failed. If an exception is thrown, the user is shown an error indicating that the properties cannot be edited.

retrieveCurrentProperties

public IRetrieveElementPropsRetVal<FcChangeStateProps> retrieveCurrentProperties(FcChangeStateProps 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<FcChangeStateProps,WorkflowNode>

Specified by:

retrieveCurrentProperties in interface INodePropertiesBean<FcChangeStateProps>

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).