Class FcExperimentHandler
- java.lang.Object
-
- de.xima.fc.workflow.designer.registry.nodes.FcExperimentHandler
-
- All Implemented Interfaces:
IResourceBundleLocator
,IWorkflowNodeFlowAnalyzer<FcExperimentProps>
,IElementHandler<FcExperimentProps,WorkflowNode>
,IExecutionResultDescriptor
,ICustomParametersUpdateable
,IWorkflowElementTypeProviding
,IBeanValidatingElement<FcExperimentProps,WorkflowNode>
,IBeanValidatingNode<FcExperimentProps>
,IExecutingLikeExceptionHandlerNode<FcExperimentProps>
,IOfficialHelpPageElement<FcExperimentProps,WorkflowNode>
,IOfficialHelpPageNode<FcExperimentProps>
,IResultlessNode<FcExperimentProps>
,ISingleElementPrototype<FcExperimentProps,WorkflowNode>
,ISingleNodePrototype<FcExperimentProps>
,INodeHandler<FcExperimentProps>
,IWorkflowNodeTypeProviding
,IListenerRegistrator
,IOrderable
,ISingleBuiltinNodePrototype<FcExperimentProps>
,IBuiltinResourcesHandler<FcExperimentProps,WorkflowNode>
,IBuiltinNodeType<FcExperimentProps>
,Comparable<IOrderable>
@Immutable public final class FcExperimentHandler extends Object implements INodeHandler<FcExperimentProps>, IBeanValidatingNode<FcExperimentProps>, IBuiltinNodeType<FcExperimentProps>, IBuiltinResourcesHandler<FcExperimentProps,WorkflowNode>, IExecutingLikeExceptionHandlerNode<FcExperimentProps>, IResultlessNode<FcExperimentProps>, ISingleBuiltinNodePrototype<FcExperimentProps>
TheINodeHandler
for nodes of typeEWorkflowNodeType.FC_EXPERIMENT
.- Since:
- 7.0.0
- Author:
- XIMA MEDIA GmbH
-
-
Field Summary
-
Fields inherited from interface de.xima.fc.interfaces.workflow.elements.IElementHandler
CURRENT_HANDLER_VERSION
-
-
Method Summary
-
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, 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, getDisplayLabel, getElementSummaryModel, getElementSummaryXhtml, getFastJsonConverter, getFilterCriteriaForEntities, getResourceBundle, getVersion, readEntityReferences, readPlaceholders, validateGlobal, writeEntityReferences, writePlaceholders
-
Methods inherited from interface de.xima.fc.interfaces.workflow.mixin.IExecutingLikeExceptionHandlerNode
createFlowGraph
-
Methods inherited from interface de.xima.fc.interfaces.workflow.execution.IExecutionResultDescriptor
getAlwaysValueDescriptor, getFileValueDescriptor
-
Methods inherited from interface de.xima.fc.interfaces.workflow.nodes.INodeHandler
getLocalizedTypeName, getPropertiesBeanClass, 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.mixin.IResultlessNode
getErrorValueDescriptor, getSuccessValueDescriptor
-
Methods inherited from interface de.xima.fc.workflow.designer.mixin.ISingleBuiltinNodePrototype
getPrototypeIcon, getPrototypeLabel, getPrototypeSearchText, getPrototypeSortKey, getPrototypeSubLabel, getPrototypeTitle
-
Methods inherited from interface de.xima.fc.interfaces.workflow.mixin.ISingleElementPrototype
getPrototypeTags, getSubCategory
-
Methods inherited from interface de.xima.fc.interfaces.workflow.mixin.ISingleNodePrototype
getNodePrototypes
-
-
-
-
Method Detail
-
getBodyChildIndex
public int getBodyChildIndex()
- Specified by:
getBodyChildIndex
in interfaceIExecutingLikeExceptionHandlerNode<FcExperimentProps>
- Returns:
- Index of the child representing the block ("try").
-
getFinalizerChildIndex
public int getFinalizerChildIndex()
- Specified by:
getFinalizerChildIndex
in interfaceIExecutingLikeExceptionHandlerNode<FcExperimentProps>
- Returns:
- Index of the child representing the finalizer ("finally").
-
getHandlerChildIndex
public int getHandlerChildIndex()
- Specified by:
getHandlerChildIndex
in interfaceIExecutingLikeExceptionHandlerNode<FcExperimentProps>
- Returns:
- Index of the child representing the handler ("catch").
-
execute
public INormalCompletionResult execute(INodeExecutionParams<FcExperimentProps> 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 useIWorkflowExecutionContext.executor()
.In case you throw any other exception other than the exceptions mentioned in the throws clause, it will be wrapped in a
NodeThrewException
.- Specified by:
execute
in interfaceINodeHandler<FcExperimentProps>
- 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 execution of the node could not be completed normally, see below.NodeThrewException
- When the execution of the node could not be completed normally due to abnormal circumstances. When this exception is thrown, execution of the workflow is cancelled, unless an error handler has been defined (such as via a try-catch node).NodeReturnedException
- When the execution of the node could not be completed normally due to a return statement. To end the execution of the workflow and return, throw this exception.
-
getBuiltinType
public EWorkflowNodeType getBuiltinType()
- Specified by:
getBuiltinType
in interfaceIBuiltinNodeType<FcExperimentProps>
- Returns:
- The built-in node type.
-
getDataModelClass
public Class<FcExperimentProps> 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<FcExperimentProps,WorkflowNode>
- Returns:
- The class corresponding to the type parameter
TData
.
-
getMainCategory
public IElementCategory getMainCategory(IGetElementPrototypesParams params)
- Specified by:
getMainCategory
in interfaceISingleElementPrototype<FcExperimentProps,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.
-
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:newWorkflowProviding id="providing" value="#{model}" /> <!-- 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<FcExperimentProps,WorkflowNode>
- Returns:
- Path to the XHTML view. 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. - Throws:
MalformedURLException
- This exception is declared for convenience - normally you would use {@link new URL} 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<FcExperimentProps,WorkflowNode>
- Specified by:
getPrototypeElement
in interfaceISingleNodePrototype<FcExperimentProps>
- 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 FcExperimentProps getPrototypeModelData(String label, IGuiIcon icon, IGetElementPrototypesParams params)
- Specified by:
getPrototypeModelData
in interfaceISingleElementPrototype<FcExperimentProps,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).
-
isCreateProtocolEntryAfterExecution
public boolean isCreateProtocolEntryAfterExecution(boolean success)
Description copied from interface:INodeHandler
Controls whether a protocol entry is created after the node was executed.The default implementation always returns
true
. May be set tofalse
for nodes such as flow control nodes (if-else, try-catch etc.).- Specified by:
isCreateProtocolEntryAfterExecution
in interfaceINodeHandler<FcExperimentProps>
- Parameters:
success
- Whether the action was executed successfully.- Returns:
true
to create a protocol entry, orfalse
otherwise.
-
getInstance
public static FcExperimentHandler getInstance()
- Returns:
- The immutable, stateless instance of this handler.
-
-