WorkflowStateModel.Builder (formcycle: bom 8.4.0 API)

java.lang.Object
- de.xima.fc.workflow.WorkflowStateModel.Builder<T>

Enclosing class:

WorkflowStateModel
```
public abstract static class WorkflowStateModel.Builder<T>
extends Object
```
Builder for configuring a WorkflowStateModel from a state entity.

Field Summary

Fields
Modifier and Type Field Description

protected T state

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`abstract WorkflowStateModel`	`build()`	Builds a new `WorkflowStateModel` with the current configuration of this builder.
`WorkflowStateModel.Builder<T>`	`clientLocale(Locale clientLocale)`	Sets the locale of the current client.
`WorkflowStateModel.Builder<T>`	`defaultEndUserState(EEndUserStatePreset preset)`	Presets to apply when the state does not yet have a end user state configured.
`WorkflowStateModel.Builder<T>`	`locale(Locale locale)`	Sets the locale to use when creating the model.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - state
```
protected final T state
```
- Method Detail
  - locale
```
public WorkflowStateModel.Builder<T> locale(Locale locale)
```
    Sets the locale to use when creating the model. Defaults to CmnConst.DFLT_LOCALE. This is used for example for localizing the authenticator names and descriptions.
    
    Parameters:
    
    locale - The locale to use.
    
    Returns:
    
    This builder for chaining method calls.
  - defaultEndUserState
```
public WorkflowStateModel.Builder<T> defaultEndUserState(EEndUserStatePreset preset)
```
    Presets to apply when the state does not yet have a end user state configured.
    
    Parameters:
    
    preset - The preset to apply.
    
    Returns:
    
    This builder for chaining method calls.
  - clientLocale
```
public WorkflowStateModel.Builder<T> clientLocale(Locale clientLocale)
```
    Sets the locale of the current client. This is used for example for creating the localizations tab of the state.
    
    Parameters:
    
    clientLocale - The locale of the client.
    
    Returns:
    
    This builder for chaining method calls.
  - build
```
public abstract WorkflowStateModel build()
```
    Builds a new WorkflowStateModel with the current configuration of this builder.
    
    Returns:
    
    A new workflow state model.