Class ElementInfoPanelModel

java.lang.Object
de.xima.fc.workflow.designer.model.ElementInfoPanelModel
All Implemented Interfaces:
Serializable
public final class ElementInfoPanelModel extends Object implements Serializable
View Model storing the data that shown in the element info dialog of the flowchart.
Since:
7.0.0
Author:
XIMA MEDIA GmbH
See Also:

  • Constructor Details

    • ElementInfoPanelModel

      public ElementInfoPanelModel()

  • Method Details

    • getAlwaysRows

      public List<ValueDescriptorRow> getAlwaysRows()
      A list of rows containing the values the node always provides, regardless of its mode of complete (normally or abruptly). Corresponds to the entries in the IValueDescriptor of the node, see getAlwaysValueDescriptor().
      Returns:
      List of always value rows.

    • setAlwaysRows

      public void setAlwaysRows(List<ValueDescriptorRow> alwaysRows)
      A list of rows containing the values the node always provides, regardless of its mode of complete (normally or abruptly). Corresponds to the entries in the IValueDescriptor of the node, see getAlwaysValueDescriptor().
      Parameters:
      alwaysRows - List of always value rows.

    • getCurrentFileRows

      public List<FileDescriptorRow> getCurrentFileRows()
      A list of rows containing the files the node provides while being executed. Corresponds to the entries in the IFileValueDescriptor of the node. See also getCurrentFileValueDescriptor().
      Returns:
      List of file rows.

    • setCurrentFileRows

      public void setCurrentFileRows(List<FileDescriptorRow> currentFileRows)
      A list of rows containing the files the node provides while being executed. Corresponds to the entries in the IFileValueDescriptor of the node. See also getCurrentFileValueDescriptor().
      Parameters:
      currentFileRows - List of file rows.

    • getCurrentRows

      public List<ValueDescriptorRow> getCurrentRows()
      A list of rows containing the values the node provides while being executed. This is used e.g. by loops. Corresponds to the entries in the IValueDescriptor of the node, see getCurrentValueDescriptor().
      Returns:
      List of current value rows.

    • setCurrentRows

      public void setCurrentRows(List<ValueDescriptorRow> currentRows)
      A list of rows containing the values the node provides while being executed. This is used e.g. by loops. Corresponds to the entries in the IValueDescriptor of the node, see getCurrentValueDescriptor().
      Parameters:
      currentRows - List of current value rows.

    • getElementHelp

      public IElementHelpLocation getElementHelp()
      Info related to further help for the element, such as an inline HTML page or external web page.
      Returns:
      The element's in-depth help.

    • setElementHelp

      public void setElementHelp(IElementHelpLocation elementHelp)
      Info related to further help for the element, such as an inline HTML page or external web page.
      Parameters:
      elementHelp - The element's in-depth help.

    • getElementType

      public EWorkflowElementType getElementType()
      Whether this info panel instance is for a WorkflowNode or WorkflowTrigger.
      Returns:
      Whether this info panel is for a node or trigger.

    • setElementType

      public void setElementType(EWorkflowElementType elementType)
      Whether this info panel instance is for a WorkflowNode or WorkflowTrigger.
      Parameters:
      elementType - Whether this info panel is for a node or trigger.

    • getElementTypeString

      public String getElementTypeString()
      The type of the node or trigger, see IWorkflowElementTypeProviding.getType(). Each type has a handler with custom logic for that node or trigger.
      Returns:
      The element's type.

    • setElementTypeString

      public void setElementTypeString(String elementTypeString)
      The type of the node or trigger, see IWorkflowElementTypeProviding.getType(). Each type has a handler with custom logic for that node or trigger.
      Parameters:
      elementTypeString - The element's type.

    • getErrorCodeSections

      public List<ErrorCodeSection> getErrorCodeSections()
      A list with error code sections. A node's execution can fail with different types of errors. Each error may provide different details (exception data) when it occurs. Each section corresponds to one of the union members of the node's error value descriptor.
      Returns:
      List of error code sections.

    • setErrorCodeSections

      public void setErrorCodeSections(List<ErrorCodeSection> errorCodeSections)
      A list with error code sections. A node's execution can fail with different types of errors. Each error may provide different details (exception data) when it occurs. Each section corresponds to one of the union members of the node's error value descriptor.
      Parameters:
      errorCodeSections - List of error code sections.

    • getFileRows

      public List<FileDescriptorRow> getFileRows()
      A list of rows containing the files the node provides. Corresponds to the entries in the IFileValueDescriptor of the node or trigger. See also getFileValueDescriptor().
      Returns:
      List of file rows.

    • setFileRows

      public void setFileRows(List<FileDescriptorRow> fileRows)
      A list of rows containing the files the node provides. Corresponds to the entries in the IFileValueDescriptor of the node or trigger. See also getFileValueDescriptor().
      Parameters:
      fileRows - List of file rows.

    • getSoftErrorCodeSections

      public List<ErrorCodeSection> getSoftErrorCodeSections()
      A list with soft error code sections. A node's execution can issue different types of soft errors (warnings). Each soft error may provide different details (exception data) when it occurs. Each section corresponds to one of the union members of the node's soft error value descriptor.
      Returns:
      List of soft error code sections.

    • setSoftErrorCodeSections

      public void setSoftErrorCodeSections(List<ErrorCodeSection> softErrorCodeSections)
      A list with soft error code sections. A node's execution can issue different types of soft errors (warnings). Each soft error may provide different details (exception data) when it occurs. Each section corresponds to one of the union members of the node's soft error value descriptor.
      Parameters:
      softErrorCodeSections - List of soft error code sections.

    • getSuccessRows

      public List<ValueDescriptorRow> getSuccessRows()
      A list of rows containing the values the node provides after its execution completes normally. This is used e.g. by most actions with business logic, such as SQL statements or sending emails. Corresponds to the entries in the IValueDescriptor of the node, see getSuccessValueDescriptor().
      Returns:
      List of current value rows.

    • setSuccessRows

      public void setSuccessRows(List<ValueDescriptorRow> successRows)
      A list of rows containing the values the node provides after its execution completes normally. This is used e.g. by most actions with business logic, such as SQL statements or sending emails. Corresponds to the entries in the IValueDescriptor of the node, see getSuccessValueDescriptor().
      Parameters:
      successRows - List of current value rows.

    • getSummaryModel

      public Object getSummaryModel()
      Custom model instance for the summary of the node or trigger. Each handler can provide custom logic for how that model is rendered in the UI, using the getSummaryXhtml().
      Returns:
      The custom summary model.

    • setSummaryModel

      public void setSummaryModel(Object summaryModel)
      Custom model instance for the summary of the node or trigger. Each handler can provide custom logic for how that model is rendered in the UI, using the getSummaryXhtml().
      Parameters:
      summaryModel - The custom summary model.

    • getSummaryXhtml

      public String getSummaryXhtml()
      Custom facelet page containing the UI for the summary of the node or trigger. Each handler can provide custom logic for how that page is rendered in the UI. The getSummaryModel() is made available to the facelet page.
      Returns:
      The custom summary facelet page.

    • setSummaryXhtml

      public void setSummaryXhtml(String summaryXhtml)
      Custom facelet page containing the UI for the summary of the node or trigger. Each handler can provide custom logic for how that page is rendered in the UI. The getSummaryModel() is made available to the facelet page.
      Parameters:
      summaryXhtml - The custom summary facelet page.

    • getTriggerDataRows

      public List<ValueDescriptorRow> getTriggerDataRows()
      A list of rows containing the values the trigger provides when is fires. This is used e.g. by a form record message posted trigger to offer data regarding the message that was posted. Corresponds to the entries in the IValueDescriptor of the trigger, see getTriggerFilesDescriptor.
      Returns:
      List of trigger data rows.

    • setTriggerDataRows

      public void setTriggerDataRows(List<ValueDescriptorRow> triggerDataRows)
      A list of rows containing the values the trigger provides when is fires. This is used e.g. by a form record message posted trigger to offer data regarding the message that was posted. Corresponds to the entries in the IValueDescriptor of the trigger, see getTriggerFilesDescriptor.
      Parameters:
      triggerDataRows - List of trigger data rows.

    • getTriggerFileRows

      public List<FileDescriptorRow> getTriggerFileRows()
      A list of rows containing the files the trigger provides. Corresponds to the entries in the IFileValueDescriptor of the trigger. See also getTriggerFilesDescriptor().
      Returns:
      List of file rows.

    • setTriggerFileRows

      public void setTriggerFileRows(List<FileDescriptorRow> triggerFileRows)
      A list of rows containing the files the trigger provides. Corresponds to the entries in the IFileValueDescriptor of the trigger. See also getTriggerFilesDescriptor().
      Parameters:
      triggerFileRows - List of file rows.

    • isEmpty

      public boolean isEmpty()
      Checks whether this info panel is empty and does not contain any content at all.
      Returns:
      True if the info panel is empty, false otherwise.

    • isNode

      public boolean isNode()
      Whether this info instance is for a WorkflowNode (or trigger).
      Returns:
      True if this info instance is for a node, false otherwise.

    • isShowDetails

      public boolean isShowDetails()
      Whether additional details should be shown on the UI.
      Returns:
      True if additional details should be shown, false otherwise.

    • setShowDetails

      public void setShowDetails(boolean showDetails)
      Whether additional details should be shown on the UI.
      Parameters:
      showDetails - True if additional details should be shown, false otherwise.

    • isTrigger

      public boolean isTrigger()
      Whether this info instance is for a WorkflowTrigger (or node).
      Returns:
      True if this info instance is for a trigger, false otherwise.

    • empty

      public static ElementInfoPanelModel empty()
      Creates an empty instance of the element info panel model with no data.
      Returns:
      An empty instance of the element info panel model.