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. Developers are strongly encouraged to subclass the WorklistAdapter instead of implementing this interface, because the interface may change in later versions.

Method Summary

void	getAdditionalData(List<ActivityInstance> instances, List<String> splitResult) Your chance to collect data.
HTMLPage	getHTMLPage() Replace the standard page or return null.
List<ActivityInstance>	getList() Non null overwrites the list, should return list of ActivityInstances.
String	getTitle() Non null overwrites the title.
void	init(HttpServletRequest req, WorklistDescription wl, User u) You can init your class with the request.
String	lineStyle(ActivityInstance ai, String style) Change the style of the line.
List<Pair<String,String>>	listFilters(List<ActivityInstance> lines) Return a list of pairs containing id and name of self defined filters.
void	modifyColumns(List<ColumnDescription> colDescs) You get the header as we suggest it, a list of reserved keywords, like "id","process", "task".
void	modifyTableLine(ActivityInstance ai, KeyedList<String,Object> line) Your chance to modify the line, called for each table line.

Method Detail

init

void init(HttpServletRequest req,
          WorklistDescription wl,
          User u)

You can init your class with the request. For your 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

String getTitle()

Non null overwrites the title.

getList

List<ActivityInstance> getList()

Non null overwrites the list, should return list of ActivityInstances.

getAdditionalData

void getAdditionalData(List<ActivityInstance> instances,
                       List<String> splitResult)

Your chance to collect data.

Parameters:

instances - the activity instances

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

modifyColumns

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.

Parameters:

colDescs - list of header fields

modifyTableLine

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

String lineStyle(ActivityInstance ai,
                 String style)

Change the style of the line.

Parameters:

ai - the activity instance

style - a style class

listFilters

List<Pair<String,String>> listFilters(List<ActivityInstance> lines)

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

Parameters:

lines - contains the ActivityInstances which will be shown.