Class FcWhileLoopHandler
- java.lang.Object
-
- de.xima.fc.workflow.designer.registry.nodes.FcWhileLoopHandler
-
- All Implemented Interfaces:
IResourceBundleLocator
,IWorkflowNodeFlowAnalyzer<FcWhileLoopProps>
,IElementHandler<FcWhileLoopProps,WorkflowNode>
,IExecutionResultDescriptor
,IRefinedExecutionResultDescriptor<FcWhileLoopProps>
,ICustomParametersUpdateable
,IWorkflowElementTypeProviding
,IBeanValidatingElement<FcWhileLoopProps,WorkflowNode>
,IBeanValidatingNode<FcWhileLoopProps>
,IExecutingLikePreTestLoopNode<FcWhileLoopProps>
,IHierarchyValidatingNode<FcWhileLoopProps>
,ILoopStatementMustLoopValidating<FcWhileLoopProps>
,IOfficialHelpPageElement<FcWhileLoopProps,WorkflowNode>
,IOfficialHelpPageNode<FcWhileLoopProps>
,ISingleElementPrototype<FcWhileLoopProps,WorkflowNode>
,ISingleNodePrototype<FcWhileLoopProps>
,INodeHandler<FcWhileLoopProps>
,IWorkflowNodeTypeProviding
,IListenerRegistrator
,IOrderable
,ISingleBuiltinNodePrototype<FcWhileLoopProps>
,IBuiltinResourcesHandler<FcWhileLoopProps,WorkflowNode>
,IBuiltinNodeType<FcWhileLoopProps>
,IMultipleCheckPropertiesNode<FcWhileLoopProps>
,IFcWhileLoopDescriptors
,Comparable<IOrderable>
@Immutable public final class FcWhileLoopHandler extends Object implements INodeHandler<FcWhileLoopProps>, IBeanValidatingNode<FcWhileLoopProps>, IBuiltinNodeType<FcWhileLoopProps>, IBuiltinResourcesHandler<FcWhileLoopProps,WorkflowNode>, IExecutingLikePreTestLoopNode<FcWhileLoopProps>, IFcWhileLoopDescriptors, ILoopStatementMustLoopValidating<FcWhileLoopProps>, IMultipleCheckPropertiesNode<FcWhileLoopProps>, ISingleBuiltinNodePrototype<FcWhileLoopProps>
TheINodeHandler
for nodes of typeEWorkflowNodeType.FC_WHILE_LOOP
.- Since:
- 8.2.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.IFcWhileLoopDescriptors
CURRENT_ATTR_INDEX, SUCCESS_ATTR_COUNT
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
equals(Object obj)
INormalCompletionResult
execute(INodeExecutionParams<FcWhileLoopProps> params)
Executes the given workflow node.EWorkflowNodeType
getBuiltinType()
Class<FcWhileLoopProps>
getDataModelClass()
Returns the class of the custom properties used by the elements handled by this element logic handler.static FcWhileLoopHandler
getInstance()
int
getLoopBodyChildIndex()
IElementCategory
getMainCategory(IGetElementPrototypesParams params)
Class<? extends INodePropertiesBean<FcWhileLoopProps>>
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.WorkflowNode
getPrototypeElement(IGetElementPrototypesParams params)
FcWhileLoopProps
getPrototypeModelData(String label, IGuiIcon icon, IGetElementPrototypesParams params)
String
getPrototypeSortKey(String label, IGetElementPrototypesParams params)
IElementCategory
getSubCategory(IGetElementPrototypesParams params)
Optional sub category.Set<String>
getSupportedControlTransferTypes()
Returns the set of control transfer types that this node can handle.int
hashCode()
boolean
isCreateProtocolEntryAfterExecution(ICreateProtocolEntryAfterExecutionParams params)
Controls whether a protocol entry is created after the node was executed.boolean
isValidChildCount(WorkflowNode node, int childCount)
Checks whether the givennumber of children
is allowed.boolean
isValidChildType(WorkflowNode node, int childIndex, String nodeType)
Checks whether thetype
of a certainworkflow node child
is allowed for that node.boolean
isValidParentType(WorkflowNode node, String nodeType)
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface de.xima.fc.interfaces.workflow.mixin.IBeanValidatingElement
getValidationGroups
-
Methods inherited from interface de.xima.fc.interfaces.workflow.mixin.IBeanValidatingNode
validateLocal
-
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, getElementSummaryModel, getElementSummaryXhtml, getFastJsonConverter, getFilterCriteriaForEntities, getJavaScript, getResourceBundle, getVersion, isHasUserVisibleName, readEntityReferences, readPlaceholders, writeEntityReferences, writePlaceholders
-
Methods inherited from interface de.xima.fc.interfaces.workflow.mixin.IExecutingLikePreTestLoopNode
createFlowGraph
-
Methods inherited from interface de.xima.fc.interfaces.workflow.execution.IExecutionResultDescriptor
getAlwaysValueDescriptor, getAttachmentValueDescriptor, getCurrentAttachmentValueDescriptor, getCurrentFileValueDescriptor, getFileValueDescriptor, getSoftErrorValueDescriptor
-
Methods inherited from interface de.xima.fc.workflow.retval.node.IFcWhileLoopDescriptors
getCurrentValueDescriptor, getErrorValueDescriptor, getSuccessValueDescriptor
-
Methods inherited from interface de.xima.fc.interfaces.workflow.mixin.ILoopStatementMustLoopValidating
validateGlobal
-
Methods inherited from interface de.xima.fc.workflow.mixin.IMultipleCheckPropertiesNode
getDisplayLabel
-
Methods inherited from interface de.xima.fc.interfaces.workflow.nodes.INodeHandler
getLocalizedTypeName, getRelatedNodeTypes, 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
-
Methods inherited from interface de.xima.fc.workflow.designer.mixin.ISingleBuiltinNodePrototype
getPrototypeIcon, getPrototypeLabel, getPrototypeSearchText, getPrototypeSubLabel, getPrototypeTitle
-
Methods inherited from interface de.xima.fc.interfaces.workflow.mixin.ISingleElementPrototype
getPrototypeTags
-
Methods inherited from interface de.xima.fc.interfaces.workflow.mixin.ISingleNodePrototype
getNodePrototypes
-
-
-
-
Method Detail
-
execute
public INormalCompletionResult execute(INodeExecutionParams<FcWhileLoopProps> 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<FcWhileLoopProps>
- 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<FcWhileLoopProps>
- Returns:
- The built-in node type.
-
getDataModelClass
public Class<FcWhileLoopProps> 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<FcWhileLoopProps,WorkflowNode>
- Returns:
- The class corresponding to the type parameter
TData
.
-
getLoopBodyChildIndex
public int getLoopBodyChildIndex()
- Specified by:
getLoopBodyChildIndex
in interfaceIExecutingLikePreTestLoopNode<FcWhileLoopProps>
- Specified by:
getLoopBodyChildIndex
in interfaceILoopStatementMustLoopValidating<FcWhileLoopProps>
- Returns:
- Index of the child representing the loop body.
-
getMainCategory
public IElementCategory getMainCategory(IGetElementPrototypesParams params)
- Specified by:
getMainCategory
in interfaceISingleElementPrototype<FcWhileLoopProps,WorkflowNode>
- Parameters:
params
- Parameters with the current client, locale, entity context etc.- Returns:
IElementCategory
element's main category, which is used for grouping the elements.
-
getPropertiesBeanClass
public Class<? extends INodePropertiesBean<FcWhileLoopProps>> 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<FcWhileLoopProps,WorkflowNode>
- Specified by:
getPropertiesBeanClass
in interfaceINodeHandler<FcWhileLoopProps>
- 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<FcWhileLoopProps,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
-
getPrototypeElement
public WorkflowNode getPrototypeElement(IGetElementPrototypesParams params)
- Specified by:
getPrototypeElement
in interfaceISingleElementPrototype<FcWhileLoopProps,WorkflowNode>
- Specified by:
getPrototypeElement
in interfaceISingleNodePrototype<FcWhileLoopProps>
- Parameters:
params
- Parameters with the current client, locale, entity context etc.- Returns:
- The workflow element that is used as a prototype. The default implementation simply creates a new
workflow element with the
IWorkflowElementTypeProviding.getType()
. Usually there is no reason to override this method.
-
getPrototypeModelData
public FcWhileLoopProps getPrototypeModelData(String label, IGuiIcon icon, IGetElementPrototypesParams params)
- Specified by:
getPrototypeModelData
in interfaceISingleElementPrototype<FcWhileLoopProps,WorkflowNode>
- Parameters:
label
- Label of the prototype, as returned byISingleElementPrototype.getPrototypeLabel(IGetElementPrototypesParams)
. Can be used to prefill the properties model with the label.icon
- Icon of the prototype, as returned byISingleElementPrototype.getPrototypeIcon(IGetElementPrototypesParams)
. Can be used to prefill the properties model with the icon.params
- Parameters with the current client, locale, entity context etc.- Returns:
- The properties model for the element prototype. This is the initial configuration when the user adds the prototype to the flowchart (via drag & drop).
-
getPrototypeSortKey
public String getPrototypeSortKey(String label, IGetElementPrototypesParams params)
- Specified by:
getPrototypeSortKey
in interfaceISingleBuiltinNodePrototype<FcWhileLoopProps>
- Specified by:
getPrototypeSortKey
in interfaceISingleElementPrototype<FcWhileLoopProps,WorkflowNode>
- Parameters:
label
- The label, as returned byISingleElementPrototype.getPrototypeLabel(IGetElementPrototypesParams)
. Can be used to sort the prototype alphabetically by its name.params
- Parameters with the current client, locale, entity context etc.- Returns:
- The sort key for the prototype, used when there are multiple prototypes within the same category. See
IElementPrototypeDescriptor.getSortKey()
.
-
getSubCategory
public IElementCategory getSubCategory(IGetElementPrototypesParams params)
Description copied from interface:ISingleElementPrototype
Optional sub category. When not set or this returnsnull
, the element is shown under the categorymiscellaneous
.- Specified by:
getSubCategory
in interfaceISingleElementPrototype<FcWhileLoopProps,WorkflowNode>
- Parameters:
params
- Parameters with the current client, locale, entity context etc.- Returns:
IElementCategory
element's sub category, which is used for grouping the element within the given main group.
-
getSupportedControlTransferTypes
public Set<String> getSupportedControlTransferTypes()
Description copied from interface:INodeHandler
Returns the set of control transfer types that this node can handle. SeeEStandardControlTransferType
for a list of built-in transfer types.If this method returns a non-empty set, the
execute
method should catchNodeTransferredControlException
. If itscontrol transfer type
is one of the supported types, it should handle that control transfer accordingly. Otherwise, it should propagate the exception upwards by rethrowing it.This method is also used by control transfer nodes (e.g. the built-in
FC_BREAK
orFC_CONTINUE
) to decide which nodes are valid targets.- Specified by:
getSupportedControlTransferTypes
in interfaceINodeHandler<FcWhileLoopProps>
- Returns:
- The control transfer types that this node can handle.
- See Also:
for a list of built-in control transfer types.
-
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<FcWhileLoopProps>
- 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.
-
isValidChildCount
public boolean isValidChildCount(WorkflowNode node, int childCount)
Description copied from interface:IHierarchyValidatingNode
Checks whether the givennumber of children
is allowed. The default implementation enforces no restriction on the number of children.- Specified by:
isValidChildCount
in interfaceIHierarchyValidatingNode<FcWhileLoopProps>
- Parameters:
node
- The parent node with the children to check.childCount
- The number of children of the node node.- Returns:
true
if the number of children are allowed.
-
isValidChildType
public boolean isValidChildType(WorkflowNode node, int childIndex, String nodeType)
Description copied from interface:IHierarchyValidatingNode
Checks whether thetype
of a certainworkflow node child
is allowed for that node. The default implementation enforces no restriction on the child type.- Specified by:
isValidChildType
in interfaceIHierarchyValidatingNode<FcWhileLoopProps>
- Parameters:
node
- The parent node with the children to check.childIndex
- 0-based index of the child to check.nodeType
- Node type of the child to check.- Returns:
true
if the child type is allowed.
-
isValidParentType
public boolean isValidParentType(WorkflowNode node, String nodeType)
Description copied from interface:IHierarchyValidatingNode
Checks whether thetype
of a certainparent
is allowed for that node. The default implementation enforces no restriction on the parent type.- Specified by:
isValidParentType
in interfaceIHierarchyValidatingNode<FcWhileLoopProps>
- Parameters:
node
- The node with the parent to check.nodeType
- Node type of the parent to check. Empty string when the node does not have a parent.- Returns:
true
if the parent type is allowed.
-
getInstance
public static FcWhileLoopHandler getInstance()
- Returns:
- The immutable, stateless instance of this handler.
-
-