Class FcChangeStateHandler
- java.lang.Object
-
- de.xima.fc.workflow.designer.registry.nodes.FcChangeStateHandler
-
- All Implemented Interfaces:
IResourceBundleLocator
,IWorkflowNodeFlowAnalyzer<FcChangeStateProps>
,IElementHandler<FcChangeStateProps,WorkflowNode>
,IExecutionResultDescriptor
,IRefinedExecutionResultDescriptor<FcChangeStateProps>
,ICustomParametersUpdateable
,IWorkflowElementTypeProviding
,IBeanValidatingElement<FcChangeStateProps,WorkflowNode>
,IBeanValidatingNode<FcChangeStateProps>
,IExecutingLikeReturningActionNode<FcChangeStateProps>
,IHierarchyValidatingNode<FcChangeStateProps>
,IKeyValueSummarizableElement<FcChangeStateProps,WorkflowNode>
,IKeyValueSummarizableNode<FcChangeStateProps>
,IOfficialHelpPageElement<FcChangeStateProps,WorkflowNode>
,IOfficialHelpPageNode<FcChangeStateProps>
,INodeHandler<FcChangeStateProps>
,IWorkflowNodeTypeProviding
,IListenerRegistrator
,IOrderable
,IBuiltinResourcesHandler<FcChangeStateProps,WorkflowNode>
,IBaseActionNode<FcChangeStateProps>
,IBuiltinNodeType<FcChangeStateProps>
,IFcChangeStateDescriptors
,Comparable<IOrderable>
@Immutable public final class FcChangeStateHandler extends Object implements INodeHandler<FcChangeStateProps>, IBaseActionNode<FcChangeStateProps>, IBuiltinNodeType<FcChangeStateProps>, IBuiltinResourcesHandler<FcChangeStateProps,WorkflowNode>, IExecutingLikeReturningActionNode<FcChangeStateProps>, IFcChangeStateDescriptors, IKeyValueSummarizableNode<FcChangeStateProps>
TheINodeHandler
for nodes of typeEWorkflowNodeType.FC_CHANGE_STATE
.- Since:
- 7.0.0
- Author:
- XIMA MEDIA GmbH
-
-
Field Summary
-
Fields inherited from interface de.xima.fc.interfaces.workflow.elements.IElementHandler
CURRENT_HANDLER_VERSION
-
Fields inherited from interface de.xima.fc.workflow.retval.node.IFcChangeStateDescriptors
ATTR_CHANGED, ATTR_NEW_STATE, ATTR_OLD_STATE, ATTR_STATE_ID, ATTR_STATE_NAME, ATTR_STATE_UUID
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
equals(Object obj)
INormalCompletionResult
execute(INodeExecutionParams<FcChangeStateProps> params)
Executes the given workflow node.EWorkflowNodeType
getBuiltinType()
Class<FcChangeStateProps>
getDataModelClass()
Returns the class of the custom properties used by the elements handled by this element logic handler.String
getDisplayLabel(IGetDisplayLabelParams<FcChangeStateProps> params)
Retrieves the display label for a workflow element.ISummaryKeyValueModel
getElementSummaryKeyValueModel(IGetElementSummaryParams<FcChangeStateProps> params)
static FcChangeStateHandler
getInstance()
List<INodePrototypeDescriptor<FcChangeStateProps>>
getNodePrototypes(IGetNodePrototypesParams params)
Returns a list of all node prototypes for this node type.Class<? extends INodePropertiesBean<FcChangeStateProps>>
getPropertiesBeanClass()
Returns the class of the bean that should be used when editing the properties of a workflow element.URL
getPropertiesViewXhtml()
This method must return the path to the XHTML page for the custom user interface.int
hashCode()
boolean
isCreateProtocolEntryAfterExecution(ICreateProtocolEntryAfterExecutionParams params)
Controls whether a protocol entry is created after the node was executed.boolean
isHasUserVisibleName()
Checks whether this workflow element has a user-facingIElementHandler.extractName(Object)
.IWorkflowElementValidationResult
validateLocal(IElementLocalValidationParams<FcChangeStateProps,WorkflowNode> params)
Performs a local validation of the given workflow workflow element properties.-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface de.xima.fc.workflow.mixin.IBaseActionNode
isValidChildCount, isValidChildType, isValidParentType
-
Methods inherited from interface de.xima.fc.interfaces.workflow.mixin.IBeanValidatingElement
getValidationGroups
-
Methods inherited from interface de.xima.fc.workflow.mixin.IBuiltinNodeType
getOfficialHelpPagePath, getType, isAvailable, register
-
Methods inherited from interface de.xima.fc.workflow.designer.registry.IBuiltinResourcesHandler
getCascadingStyleSheet, getJavaScript
-
Methods inherited from interface de.xima.fc.interfaces.workflow.ICustomParametersUpdateable
updateCustomParams
-
Methods inherited from interface de.xima.fc.interfaces.workflow.elements.IElementHandler
extractDescription, extractName, extractSearchTerms, getCascadingStyleSheet, getFastJsonConverter, getFilterCriteriaForEntities, getJavaScript, getResourceBundle, getVersion, readEntityReferences, readPlaceholders, validateGlobal, writeEntityReferences, writePlaceholders
-
Methods inherited from interface de.xima.fc.interfaces.workflow.mixin.IExecutingLikeReturningActionNode
createFlowGraph
-
Methods inherited from interface de.xima.fc.interfaces.workflow.execution.IExecutionResultDescriptor
getAlwaysValueDescriptor, getAttachmentValueDescriptor, getCurrentAttachmentValueDescriptor, getCurrentFileValueDescriptor, getCurrentValueDescriptor, getFileValueDescriptor
-
Methods inherited from interface de.xima.fc.workflow.retval.node.IFcChangeStateDescriptors
getErrorValueDescriptor, getSoftErrorValueDescriptor, getSuccessValueDescriptor
-
Methods inherited from interface de.xima.fc.interfaces.workflow.mixin.IKeyValueSummarizableElement
getElementSummaryModel, getElementSummaryXhtml
-
Methods inherited from interface de.xima.fc.interfaces.workflow.nodes.INodeHandler
getLocalizedTypeName, getRelatedNodeTypes, getSupportedControlTransferTypes, isCreateProtocolEntryAfterExecution, isReplacePlaceholderBeforeExecution
-
Methods inherited from interface de.xima.fc.interfaces.workflow.mixin.IOfficialHelpPageElement
getHelpPageLocation
-
Methods inherited from interface de.xima.fc.listener.IOrderable
compareTo, shouldBeAfter
-
Methods inherited from interface de.xima.fc.interfaces.workflow.execution.IRefinedExecutionResultDescriptor
getAlwaysValueDescriptor, getAttachmentValueDescriptor, getCurrentAttachmentValueDescriptor, getCurrentFileValueDescriptor, getCurrentValueDescriptor, getErrorValueDescriptor, getFileValueDescriptor, getSoftErrorValueDescriptor, getSuccessValueDescriptor
-
-
-
-
Method Detail
-
execute
public INormalCompletionResult execute(INodeExecutionParams<FcChangeStateProps> params) throws AbstractAbruptCompletionException
Description copied from interface:INodeHandler
Executes the given workflow node. You may perform any action required by this node type, such as creating files, sending HTTP requests etc.If this node has children that need to be executed (such as for control nodes like conditions or switches), you must use
IWorkflowExecutionContext.executor()
to execute the children instead of attempting to call their execute method directly. Note that a node must never attempt to execute any other node that is not in the subtree (= a child, a grand-child, a grand-grand-child etc.) of this node.In case you throw any other exceptions other than the exceptions mentioned in the throws clause, it will be wrapped in a
NodeThrewException
with a general error code.- Specified by:
execute
in interfaceINodeHandler<FcChangeStateProps>
- Parameters:
params
- The node that needs to be executed and the current workflow context.- Returns:
- The result value or values created by the executed node.
- Throws:
AbstractAbruptCompletionException
- When the node's execution did not finish normally, see below for subclasses.NodeThrewException
- If this exception was thrown by the execute method of the given node. Indicates that a node could not be completed successfully. This exception can be caught by control flow nodes with custom error handling, such as a try-catch node.NodeReturnedException
- If this exception was thrown by the execute method of the given node. Indicates that the node wishes to return, i.e. to stop the execution of the current processing chain (="function"). This exception can be caught by control flow nodes with custom finalization handling, such as a try-finally node (which should rethrow this exception afterwards).NodeTransferredControlException
- If this exception was thrown by the execute method of the given node. Indicates that a control transfer should take place. The matching node for thecontrol transfer target
should catch this exception and proceed according to thetype of the control transfer
. For example, loop nodes may catch break and continue control transfers and either stop the loop or skip to the next iteration of the loop.
-
getBuiltinType
public EWorkflowNodeType getBuiltinType()
- Specified by:
getBuiltinType
in interfaceIBuiltinNodeType<FcChangeStateProps>
- Returns:
- The built-in node type.
-
getDataModelClass
public Class<FcChangeStateProps> getDataModelClass()
Description copied from interface:IElementHandler
Returns the class of the custom properties used by the elements handled by this element logic handler.The custom properties of a workflow element are internally stored as JSON. To ease the development work, you can specify a model class, and the JSON is automatically converted to an instance of that model class. Please note that the model class must be compatible with serialization mechanism used by
JSON
.See
IElementHandler.getVersion()
for how custom properties are updated.If you need more control over serialization and deserialization, specify
JSONObject
as the type parameter and returnJSONObject.class
. You will then receive the raw JSON data and may perform the serialization in whatever way you like.- Specified by:
getDataModelClass
in interfaceIElementHandler<FcChangeStateProps,WorkflowNode>
- Returns:
- The class corresponding to the type parameter
TData
.
-
getDisplayLabel
public String getDisplayLabel(IGetDisplayLabelParams<FcChangeStateProps> params)
Description copied from interface:IElementHandler
Retrieves the display label for a workflow element. Compared withIElementHandler.extractName(Object)
, this label may depend on the locale and is not saved in the database. Furthermore, the display label may depend on the context, such as the name of a workflow state etc. While not every element may have a name, every element should have a display label.The default implementation delegates to
IElementHandler.extractName(Object)
.- Specified by:
getDisplayLabel
in interfaceIElementHandler<FcChangeStateProps,WorkflowNode>
- Parameters:
params
- Parameters with the element's deserialized properties model, the locale and additional context data.- Returns:
- The display label of the element in the given locale.
-
getElementSummaryKeyValueModel
public ISummaryKeyValueModel getElementSummaryKeyValueModel(IGetElementSummaryParams<FcChangeStateProps> params)
- Specified by:
getElementSummaryKeyValueModel
in interfaceIKeyValueSummarizableElement<FcChangeStateProps,WorkflowNode>
- Parameters:
params
- The custom properties of the node or trigger.- Returns:
- A list of key value pairs to display in a table in the overview panel.
-
getNodePrototypes
public List<INodePrototypeDescriptor<FcChangeStateProps>> getNodePrototypes(IGetNodePrototypesParams params)
Description copied from interface:INodeHandler
Returns a list of all node prototypes for this node type. Each prototype appears in the drawer panel of the workflow designer. The user can move a node prototype via drag & drop into the design area in the center to add the node to the current flowchart.You should always return all prototypes, irrespective of whether they are allowed to the current user.
IElementHandler.isAvailable(IIsAvailableParams)
is checked by the engine, and unavailable node types are removed automatically.- Specified by:
getNodePrototypes
in interfaceINodeHandler<FcChangeStateProps>
- Parameters:
params
- Parameters for this method, such as the current locale for localizing the display name of the prototypes.- Returns:
- A list of all available prototypes.
null
is treated as an empty list.
-
getPropertiesBeanClass
public Class<? extends INodePropertiesBean<FcChangeStateProps>> getPropertiesBeanClass()
Description copied from interface:IElementHandler
Returns the class of the bean that should be used when editing the properties of a workflow element. May benull
if you do not require any bean or custom logic. When you only wish to access the properties of yourIElementHandler.getDataModelClass()
, you do have to use a custom bean - the model is available via the expression language variablemodel
. SeeIElementHandler.getPropertiesViewXhtml()
for further details.The default returns
null
, which uses no extra bean. An extra bean may not be required for simple UIs if you only need to access the properties model of the workflow element - seeIElementHandler.getPropertiesViewXhtml()
.- Specified by:
getPropertiesBeanClass
in interfaceIElementHandler<FcChangeStateProps,WorkflowNode>
- Specified by:
getPropertiesBeanClass
in interfaceINodeHandler<FcChangeStateProps>
- Returns:
- The class of the bean to use for editing a workflow node's properties.
- See Also:
IElementHandler.getPropertiesViewXhtml()
-
getPropertiesViewXhtml
public URL getPropertiesViewXhtml() throws MalformedURLException
Description copied from interface:IElementHandler
This method must return the path to the XHTML page for the custom user interface. Usually the XHTML file is part of the JAR resources of the module or plugin. In this case, you should return an URL to a JAR file resource (jar:file:/...
) like so:@Override public URL getXhtmlView() { return getClass().getResource("/path/to/view.xhtml"); }
The contents of this XHTML page is included in the properties panel, without a fieldset or container around it, but already inside a form (i.e. do not use a
h:form
as that would result in an error). You should wrap your custom UI in a naming container to ensure unique IDs that do not clash with other plugins or actions. The following is a recommended template on which you may base your UI:<ui:composition xmlns="http://www.w3.org/1999/xhtml" xmlns:h="http://xmlns.jcp.org/jsf/html" xmlns:f="http://xmlns.jcp.org/jsf/core" xmlns:ui="http://xmlns.jcp.org/jsf/facelets" xmlns:o="http://omnifaces.org/ui" xmlns:p="http://primefaces.org/ui" xmlns:xi="http://www.xima.de/taglib/xfc"> <!-- Enable bean validation (when #validateLocal is implemented via the bean validator)--> <o:validateBean value="#{model}" showMessageFor="@violating" method="validateActual" /> <xi:namingContainer id="myAwesomeWorkflowElement"> <!--Base info with name and description (when TData extends BaseActionProps) --> <xi:newWorkflowActionBase id="base" value="#{model}" legend="#{msg['wf.node.myawesomelememnt']}" /> <!-- Remove when TData does not have a
ISingleFileProviding
field --> <xi:singleFile id="resource" value="#{model.singleFile}" required="true" /> <!-- Remove when TData does not have aIMultiFileProviding
field --> <xi:multiFile id="resource" value="#{model.multiFile}" required="true" /> <!-- Remove when TData does not implement IProviding --> <xi:fileProvision id="providing" value="#{model.fileProvision}" /> <!-- Custom section with editors specific to your workflow element --> <p:fieldset legend="#{msg['MyAwesomeWorkflowElementProps.fieldset.base']}" styleClass="fc-fieldset"> <!-- A simple input field bound to the mail property of your properties model --> <xi:inputText id="mail" label="#{msg['MyAwesomeWorkflowElementProps.mail']}" formPlaceholder="true" value="#{model.mail}" forceIndicateRequired="true" > <p:ajax event="change" partialSubmit="true" listener="#{elementPropertiesBean.storeCurrent}" process="@this" update=":flowchartForm:flowchart" global="false" /> </xi:inputText> </p:fieldset> </xi:namingContainer> </ui:composition>The XHTML page may access the following expression language variables:
- model: The deserialized custom properties of the workflow element, of the type
TData
. - provider: An object that implements
IWorkflowProvider
, for accessing various data, such as a list of all users or text templates. - msg: The localized messages as returned by
IElementHandler.getResourceBundle(Locale)
. Empty when that method returnsnull
. For example, if the resource bundle contains the keymail.label
, you can access the localized message via the EL expression['mail.label']
To access the values of an enum or the constants defined by a class, consider using
<xi:importConstants type="my.fully.classified.path.MyEnum" var="MyEnum" loader="#{model}"/>
Theloader
argument is only required for plugins and ensures that the correct class loader is used that knows about the plugin class. Without the loader attribute, the above is equivalent to the PrimeFaces tag handler<p:importConstants />
.- Specified by:
getPropertiesViewXhtml
in interfaceIElementHandler<FcChangeStateProps,WorkflowNode>
- Returns:
- Path to the XHTML view. If the action can be configured, this must not return
null
. If you do returnnull
, it will be treated as an error and an appropriate message is displayed to the user informing them that the properties panel could not be loaded. If the action cannot be configured (i.e. when the action is not selectable), this should returnnull
. - Throws:
MalformedURLException
- This exception is declared for convenience - normally you would usenew URL(String)
with a constant URL string that should not throw. In case an exception is thrown, it is treated the same as if this returnednull
.
- model: The deserialized custom properties of the workflow element, of the type
-
isCreateProtocolEntryAfterExecution
public boolean isCreateProtocolEntryAfterExecution(ICreateProtocolEntryAfterExecutionParams params)
Description copied from interface:INodeHandler
Controls whether a protocol entry is created after the node was executed.The default implementation returns true iff result was created by the current node.
When some action throws an exception, all parent control flow node such as if-else statements also throw an exception. This would result in multiple protocol entries for a single error.
- Specified by:
isCreateProtocolEntryAfterExecution
in interfaceINodeHandler<FcChangeStateProps>
- Parameters:
params
- Parameters with the node that was executed and the result of the node's execution.- Returns:
true
to create a protocol entry, orfalse
otherwise.
-
isHasUserVisibleName
public boolean isHasUserVisibleName()
Description copied from interface:IElementHandler
Checks whether this workflow element has a user-facingIElementHandler.extractName(Object)
. If so, the name should usually be editable on the UI. If not, the name is a technical name that should not be shown to the user.- Specified by:
isHasUserVisibleName
in interfaceIElementHandler<FcChangeStateProps,WorkflowNode>
- Returns:
true
if theIElementHandler.extractName(Object)
can be visible to the user.
-
validateLocal
public IWorkflowElementValidationResult validateLocal(IElementLocalValidationParams<FcChangeStateProps,WorkflowNode> params) throws WorkflowValidationException
Description copied from interface:IElementHandler
Performs a local validation of the given workflow workflow element properties. This method should only validate the properties of the given workflow element, without respect to any other workflow elements.This method allows you to implement custom validation logic. Consider using
IBeanValidatingElement
and annotating your properties model class with the annotation from the bean annotation APIjavax.validation
. This also offers the advantage that it can be integrated into JSF, allowing you to use the same validations for the UI view as well.- Specified by:
validateLocal
in interfaceIBaseActionNode<FcChangeStateProps>
- Specified by:
validateLocal
in interfaceIBeanValidatingElement<FcChangeStateProps,WorkflowNode>
- Specified by:
validateLocal
in interfaceIBeanValidatingNode<FcChangeStateProps>
- Specified by:
validateLocal
in interfaceIElementHandler<FcChangeStateProps,WorkflowNode>
- Specified by:
validateLocal
in interfaceIHierarchyValidatingNode<FcChangeStateProps>
- Parameters:
params
- The properties to validate. Also provides access to the project, client etc.- Returns:
- The result of the validation, i.e. whether the workflow element is valid, and a list of messages to
display to the user. If this returns, this is treated as if a valid result without messages had been
returned. You may use use params.
getValidationContext()
.resultBuilder()
to create the result, or implement the interface yourself. To indicate that the validation was performed, but no validation constraints were violated, simply callbuild
on the result builder and return that, without adding any messages. - Throws:
WorkflowValidationException
- When the validation could not be performed. Please note that this is meant for unexpected errors only - you should not throw an exception if a workflow element is simply just invalid.
-
getInstance
public static FcChangeStateHandler getInstance()
- Returns:
- The immutable, stateless instance of this handler.
-
-