Package de.xima.fc.workflow.designer.registry.triggers

Class FcCatchErrorHandler

java.lang.Object
de.xima.fc.workflow.designer.registry.triggers.FcCatchErrorHandler
All Implemented Interfaces:
IResourceBundleLocator, IElementHandler<FcCatchErrorProps,WorkflowTrigger>, ITriggerDataDescriptor, ICustomParametersUpdateable, IWorkflowElementTypeProviding, IBeanValidatingElement<FcCatchErrorProps,WorkflowTrigger>, IBeanValidatingTrigger<FcCatchErrorProps>, IKeyValueSummarizableElement<FcCatchErrorProps,WorkflowTrigger>, IKeyValueSummarizableTrigger<FcCatchErrorProps>, IOfficialHelpPageElement<FcCatchErrorProps,WorkflowTrigger>, IOfficialHelpPageTrigger<FcCatchErrorProps>, ISingleElementPrototype<FcCatchErrorProps,WorkflowTrigger>, ISingleTriggerPrototype<FcCatchErrorProps>, ITriggerHandler<FcCatchErrorProps>, IWorkflowTriggerTypeProviding, IListenerRegistrator, IOrderable, ISingleBaseBuiltinTriggerPrototype<FcCatchErrorProps>, ISingleBuiltinTriggerPrototype<FcCatchErrorProps>, IBaseTrigger<FcCatchErrorProps>, IBuiltinTriggerType<FcCatchErrorProps>, IDefaultClientHandlerTrigger<FcCatchErrorProps>, ISingleBaseTriggerPrototype<FcCatchErrorProps>, IFcCatchErrorDescriptors, Comparable<IOrderable>
@Immutable public final class FcCatchErrorHandler extends Object implements ITriggerHandler<FcCatchErrorProps>, IBaseTrigger<FcCatchErrorProps>, IBeanValidatingTrigger<FcCatchErrorProps>, IBuiltinTriggerType<FcCatchErrorProps>, IDefaultClientHandlerTrigger<FcCatchErrorProps>, IFcCatchErrorDescriptors, ISingleBaseBuiltinTriggerPrototype<FcCatchErrorProps>, IKeyValueSummarizableTrigger<FcCatchErrorProps>
The ITriggerHandler for nodes of type EWorkflowTriggerType.FC_CATCH_ERROR.
Since:
7.0.0
Author:
XIMA MEDIA GmbH

  • Method Details

    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object

    • getBuiltinType

      public EWorkflowTriggerType getBuiltinType()
      Specified by:
      getBuiltinType in interface IBuiltinTriggerType<FcCatchErrorProps>
      Returns:
      The built-in trigger type.

    • getElementSummaryKeyValueModel

      public ISummaryKeyValueModel getElementSummaryKeyValueModel(IGetElementSummaryParams<FcCatchErrorProps> params)
      Specified by:
      getElementSummaryKeyValueModel in interface IKeyValueSummarizableElement<FcCatchErrorProps,WorkflowTrigger>
      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.

    • getDataModelClass

      public Class<FcCatchErrorProps> 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 return JSONObject.class. You will then receive the raw JSON data and may perform the serialization in whatever way you like.

      Specified by:
      getDataModelClass in interface IElementHandler<FcCatchErrorProps,WorkflowTrigger>
      Returns:
      The class corresponding to the type parameter TData.

    • getFilterCriteriaForEvent

      public de.xima.cmn.criteria.FilterCriterion getFilterCriteriaForEvent(ITriggerFilterCriteriaForEventParams params)
      Description copied from interface: ITriggerHandler
      Called once with the event data when an event is fired. Each handler may add filter criteria to locate the triggers that match the event data.

      This method must return a non-null value to indicate that the event applies to this type of trigger at all. When this returns null, no triggers of this handler type are considered. The filter criterion returned by this method is used for a query for WorkflowTrigger entities, i.e. all attribute names must be relative to that entity.

      For example, to limit the result to triggers which have a search term with the key customKey set to valueForCustomKey, use: 

       return params.searchTermExists("customKey", valueForCustomKey);
      To create a complex filter, use or / and etc. If you cannot use a database filter to check whether a trigger applies, use always to fetch all triggers for this handler type, and implement isAppliesToEvent to filter the applicable triggers via Java code.

      Basic restrictions such as the trigger type, the form record and project are applied automatically by the system and do not need to be included in the returned filter.

      See the class level documentation ITriggerHandler for more details.

      Specified by:
      getFilterCriteriaForEvent in interface ITriggerHandler<FcCatchErrorProps>
      Parameters:
      params - Parameters with the event data of the event that occurred.
      Returns:
      A filter criterion to restrict the list of matching triggers for this handler type. When null is returned, no triggers of this handler type are considered.

    • getMainCategory

      public IElementCategory getMainCategory(IGetElementPrototypesParams params)
      Specified by:
      getMainCategory in interface ISingleElementPrototype<FcCatchErrorProps,WorkflowTrigger>
      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 a IMultiFileProviding 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 returns null. For example, if the resource bundle contains the key mail.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}"/>
      The loader 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 interface IElementHandler<FcCatchErrorProps,WorkflowTrigger>
      Returns:
      Path to the XHTML view. If the action can be configured, this must not return null. If you do return null, 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 return null.
      Throws:
      MalformedURLException - This exception is declared for convenience - normally you would use new 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 returned null.

    • getSubCategory

      public IElementCategory getSubCategory(IGetElementPrototypesParams params)
      Description copied from interface: ISingleElementPrototype
      Optional sub category. When not set or this returns null, the element is shown under the category miscellaneous.
      Specified by:
      getSubCategory in interface ISingleElementPrototype<FcCatchErrorProps,WorkflowTrigger>
      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.

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • isAppliesToEvent

      public boolean isAppliesToEvent(ITriggerAppliesToEventParams<FcCatchErrorProps> params)
      Description copied from interface: ITriggerHandler
      Called once the database query for matching triggers completes successfully. May be used to restrict the list of candidate triggers returned by the database query for matching triggers. This is useful, for example, when the check cannot be expressed as a database query. The tasks of triggers for which this method returns false are not executed.

      See the class level documentation ITriggerHandler for more details.

      Specified by:
      isAppliesToEvent in interface ITriggerHandler<FcCatchErrorProps>
      Parameters:
      params - The parameters with the event that occurred and a trigger returned by the database query for matching triggers.
      Returns:
      Whether the given trigger applies to the the given event. If not, the task for that trigger is not executed.

    • isPreconditionSatisfied

      public boolean isPreconditionSatisfied(ITriggerPreconditionSatisfiedParams<FcCatchErrorProps> params)
      Description copied from interface: ITriggerHandler
      Called once the task of a trigger is about to be executed. This method may return false to prevent the task from being executed. When an event triggers multiple tasks, the execution of one task may invalidate the preconditions for a later task, so this method can be used to check whether the precondition is still satisfied.

      See the class level documentation ITriggerHandler for more details.

      Specified by:
      isPreconditionSatisfied in interface ITriggerHandler<FcCatchErrorProps>
      Parameters:
      params - The parameters with the task about to be executed.
      Returns:
      true to proceed with the task's execution, false to skip the task's execution.

    • onTaskBegin

      public IOnTaskBeginRetVal onTaskBegin(ITriggerOnTaskBeginParams<FcCatchErrorProps> params)
      Description copied from interface: ITriggerHandler
      Callback that is invoked just before a task that has a trigger of this type is executed. You may use this callback method to set up the execution context.

      This method should return the data that should be made available via IWorkflowVariableHandler.getTriggerData(String). This data is also available via a placeholder.

      Specified by:
      onTaskBegin in interface ITriggerHandler<FcCatchErrorProps>
      Parameters:
      params - Parameters passed to the callback that contain the trigger data and the execution context.
      Returns:
      Result of the begin callback, see IOnTaskBeginRetVal.

    • onTaskFinish

      public void onTaskFinish(ITriggerOnTaskFinishParams<FcCatchErrorProps> params)
      Description copied from interface: ITriggerHandler
      Callback that is invoked just after a task that has a trigger of this type was executed. You may use this callback method to clean up the execution context, such as by removing certain variables added by ITriggerHandler.onTaskBegin(ITriggerOnTaskBeginParams).

      In case ITriggerHandler.onTaskBegin(ITriggerOnTaskBeginParams) threw an exception, this is not called.

      Specified by:
      onTaskFinish in interface ITriggerHandler<FcCatchErrorProps>
      Parameters:
      params - Parameters passed to the callback that contain the trigger data and the execution context.

    • getInstance

      public static FcCatchErrorHandler getInstance()
      Returns:
      The immutable (stateless) instance of this handler.