com.groiss.wf.html
Interface WorklistDescription

public interface WorklistDescription

This interface can be used to get properties of the worklist. An object implementing this interface is supplied in the init method od the worklist interface.

Field Summary

static int	COMPATIBILITY
static int	TABS
static int	TABS_WITHOUT_FORMS

Method Summary

KeyedList	getAllColumns() Returns the list of all columns that can be shown.
Application	getApplication() Returns the application this worklist belongs to, may be null.
java.util.List	getColumnDescriptions() The list of column descriptions
java.util.List	getColumns() The list of the column ids that will be shown.
java.util.List	getEditableColumns() The list of editable columns
DMSForm	getForm(ProcessInstance pi, java.lang.String formid) Get the form for a process instance
java.lang.String	getId() The id of the list.
int	getLinkType()
int	getType() returns the type of the worklist.
boolean	isFillCounter() Returns true, if the worklist is build only for setting the counters.
void	needForm(java.lang.String processid, int version, java.lang.String formid) Call this method if you need a form from a process instance

Field Detail

COMPATIBILITY

static final int COMPATIBILITY

See Also:

Constant Field Values

TABS

static final int TABS

See Also:

Constant Field Values

TABS_WITHOUT_FORMS

static final int TABS_WITHOUT_FORMS

See Also:

Constant Field Values

Method Detail

getType

int getType()

returns the type of the worklist. See the documentation what each number represents.

Returns:

an integer defining the worklist type

getId

java.lang.String getId()

The id of the list.

Returns:

the id of the xml file followed by a "." and by the id of the worklist

getApplication

Application getApplication()

Returns the application this worklist belongs to, may be null.

Returns:

the application

getAllColumns

KeyedList getAllColumns()

Returns the list of all columns that can be shown.

Returns:

a KeyedList. keys are the ids, values the names of the columns

getColumns

java.util.List getColumns()

The list of the column ids that will be shown.

Returns:

a list of strings

getEditableColumns

java.util.List getEditableColumns()

The list of editable columns

Returns:

a list of strings

getColumnDescriptions

java.util.List getColumnDescriptions()

The list of column descriptions

Returns:

a list of strings

getLinkType

int getLinkType()

needForm

void needForm(java.lang.String processid,
              int version,
              java.lang.String formid)

Call this method if you need a form from a process instance

Parameters:

processid - id of process definition

version - version of process definition

formid - id of form

getForm

DMSForm getForm(ProcessInstance pi,
                java.lang.String formid)

Get the form for a process instance

Parameters:

pi - the process instance

formid - the id of the form

Returns:

the form

isFillCounter

boolean isFillCounter()

Returns true, if the worklist is build only for setting the counters. If true, the methods getHTMLPage(). getTitle() and lineStyle() of the worklist are not called.

Returns:

true, if only counters are set.