com.groiss.wf.html
Interface Worklist

All Known Implementing Classes:

WorklistAdapter

public interface Worklist

Interface that allows implementers to customize the worklist. Methods are called in the given order.

Method Summary

void	getAdditionalData(java.util.List instances, java.util.Vector splitResult) Your chance to collect data
HTMLPage	getHTMLPage() replace the standard page or return null
java.util.List	getList() non null overwrites the list, should return list of ActivityInstances
java.lang.String	getTitle() non null overwrites the title.
void	init(javax.servlet.http.HttpServletRequest req, WorklistDescription wl, User u) You can init your class with the request for you convenience, we tell you the type of the worklist, the application, and the user
java.lang.String	lineStyle(ActivityInstance ai, java.lang.String style) Change the style of the line.
java.util.List	listFilters(java.util.List lines) Return a list of pairs containing id and name of self defined filters.
void	modifyTableHeader(java.util.List header) You get the header as we suggest it, a list of reserved keywords, like "id","process", "task".
void	modifyTableLine(ActivityInstance ai, KeyedList line) Your chance to modify the line, called for each table line.

Method Detail

init

void init(javax.servlet.http.HttpServletRequest req,
          WorklistDescription wl,
          User u)

You can init your class with the request for you convenience, we tell you the type of the worklist, the application, and the user

Parameters:

req - the request

wl - the worklist description

u - the user

getHTMLPage

HTMLPage getHTMLPage()

replace the standard page or return null

getTitle

java.lang.String getTitle()

non null overwrites the title.

getList

java.util.List getList()

non null overwrites the list, should return list of ActivityInstances

getAdditionalData

void getAdditionalData(java.util.List instances,
                       java.util.Vector splitResult)

Your chance to collect data

Parameters:

instances - the activity instances

splitResult - a list of strings containing the oids of the process

modifyTableHeader

void modifyTableHeader(java.util.List header)

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.

Parameters:

header - a list of pairs with keyword and label

modifyTableLine

void modifyTableLine(ActivityInstance ai,
                     KeyedList 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

java.lang.String lineStyle(ActivityInstance ai,
                           java.lang.String style)

Change the style of the line.

listFilters

java.util.List listFilters(java.util.List lines)

Return a list of pairs containing id and name of self defined filters.

Parameters:

lines - contains the ActivityInstances which will be shown.