Package com.groiss.wf.html

Interface Worklist

All Known Implementing Classes:
CombinedWorklist, FilteredWorklist, WorklistAdapter
public interface Worklist
Interface that allows implementers to customize the worklist. Methods are called in the given order.

  • Method Details

    • init

      default void init(HttpServletRequest req, WorklistDescription wl, User u)
      You can init your class with the request. For your convenience, we tell you the kind of the worklist and the user
      Parameters:
      req - the request; may be null when called from notification threads
      wl - the worklist description
      u - the user

    • getHTMLPage

      @Deprecated default HTMLPage getHTMLPage()
      Deprecated.
      Replace the standard page or return null.

    • getTitle

      default Object getTitle()
      Non null overwrites the title. Only called in 8.0 compatibility mode.

    • getList

      default List<ActivityInstance> getList(List<ActivityInstance> l)
      Change the list. Usually used for filtering, but the list can be extended, too. If getList() potentially extends the list by adding ActivityInstances not originally in it, then the type of the worklist node must include kind WorklistKind.AUGMENTED.

    • getAdditionalData

      default void getAdditionalData(List<ActivityInstance> instances)
      Your chance to collect additional data for the instances. The method is not called when the list of instances is empty.
      Parameters:
      instances - the activity instances

    • modifyColumns

      default void modifyColumns(List<ColumnDescription> colDescs)
      You get the header as we suggest it, a list of reserved keywords, like "id","process", "task". You can change this header as you like. The resulting header is used to build the table lines: for the keywords we add the corresponding column, for other names we add "null" elements. For smartclient this method is called when building the main-page
      Parameters:
      colDescs - list of header fields

    • modifyTableLine

      default void modifyTableLine(ActivityInstance ai, Map<String,Object> line)
      Your chance to modify the line, called for each table line. Making the list empty removes the item from the worklist.
      Parameters:
      ai - the activity instance
      line - the line

    • lineStyle

      default String lineStyle(ActivityInstance ai, String style)
      Change the style of the line.
      Parameters:
      ai - the activity instance
      style - a style class

    • listFilters

      default List<Pair<String,String>> listFilters()
      Return a list of pairs containing id and name of self defined filters.