Package com.apgar.common.lib.filter

Class WorkflowIdUITableFilter

java.lang.Object
com.orchestranetworks.ui.UITableFilter
com.apgar.common.lib.filter.WorkflowIdUITableFilter
public class WorkflowIdUITableFilter extends com.orchestranetworks.ui.UITableFilter
A custom UI table filter designed to keep only records that were modified or created within the current workflow workspace. If this filter is applied outside of the workflow context, it will not filter any records, and all records will be displayed.

To implement this filter, include it in the XSD file for the dataset under the relevant table as follows: 

 <xs:complexType name="SampleTable_Type">
     <xs:annotation>
         <xs:documentation xml:lang="en-US">
             <osd:label>Sample Table</osd:label>
         </xs:documentation>
         <xs:appinfo>
             <osd:table>...</osd:table>
             <osd:uiFilter class="com.apgar.common.lib.filter.WorkflowIdUITableFilter">
                 <workflowIdFieldPath>./workflowId</workflowIdFieldPath>
                 <label>Modified Records Search</label>
             </osd:uiFilter>
         </xs:appinfo>
     </xs:annotation>
 </xs:complexType>

The workflowIdFieldPath parameter specifies the path of the workflow ID in the record. If omitted, the filter defaults to checking the path: ./tracking/workflowId.

Author:
APGAR Consulting

  • Constructor Summary

    Constructors
    Constructor
    Description
    WorkflowIdUITableFilter()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    addForEdit(com.orchestranetworks.ui.UITableFilterResponseContext context)
    Adds editable forms that allow users to set and customize the filtering.
    String
    getWorkflowIdFieldPath()
    Returns the string representation of the workflow ID field path.
    void
    handleApply(com.orchestranetworks.ui.UITableFilterRequestContext context)
    Handles the filtering request when the "Apply filter" button is selected.
    void
    setWorkflowIdFieldPath(String workflowIdFieldPath)
    Sets the path of the workflow ID field.

    Methods inherited from class com.orchestranetworks.ui.UITableFilter

    addForPrint, getLabel, handleReset, handleSelect, hasFilterToApply, isResetButtonEnabled, setLabel, setLabel, setLabel, setLabelUserMessage

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • WorkflowIdUITableFilter

      public WorkflowIdUITableFilter()

  • Method Details

    • getWorkflowIdFieldPath

      public String getWorkflowIdFieldPath()
      Returns the string representation of the workflow ID field path.
      Returns:
      the workflowIdFieldPath

    • setWorkflowIdFieldPath

      public void setWorkflowIdFieldPath(String workflowIdFieldPath)
      Sets the path of the workflow ID field.
      Parameters:
      workflowIdFieldPath - the workflowIdFieldPath to set

    • addForEdit

      public void addForEdit(com.orchestranetworks.ui.UITableFilterResponseContext context)
      Adds editable forms that allow users to set and customize the filtering. By default, this does nothing.
      Specified by:
      addForEdit in class com.orchestranetworks.ui.UITableFilter
      Parameters:
      context - the context of the UI table filter response

    • handleApply

      public void handleApply(com.orchestranetworks.ui.UITableFilterRequestContext context)
      Handles the filtering request when the "Apply filter" button is selected.
      Specified by:
      handleApply in class com.orchestranetworks.ui.UITableFilter
      Parameters:
      context - the context of the UI table filter request