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 of the worklist interface.

Field Summary

Fields

Modifier and Type	Field and Description
static int	COMPATIBILITY The links in the worklist are shown like in @enterprise 6.4
static int	TABS The links in the worklist lead to a tabbed frame containing the forms, documents,notes, history, and process information
static int	TABS_WITHOUT_FORMS Detail links like in TABS, but forms are not shown in the tabbed view.

Method Summary

Modifier and Type	Method and Description
Application	getApplication() Returns the application this worklist belongs to, may be null.
String	getAttrib(String key) get an attribute from the xml description
List<ColumnDescription>	getColumns() The list of the column ids that will be shown.
DMSForm	getForm(ProcessInstance pi, String formid) Get the form for a process instance
Set<DMSForm>	getForms(String formid) Get all forms with a specific formid.
String	getId() The id of the list.
int	getLinkType() Returns how the links to the detail information are configured
int	getType() Returns the type of the worklist.
boolean	isAugmentedItem(ActivityInstance item) Returns true, if the ActivityInstance has been included because of augmentation.
boolean	isDelta() Returns true, if the worklist is build only for changes (client notifications) and not as a whole
boolean	isFillCounter() Returns true, if the worklist is build only for setting the counters.
void	needForm(ProcessDefinition pd, String formid) Call this method if you need a form from a process instance
void	needForm(String processid, int version, String formid) Call this method if you need a form from a process instance

Field Detail

COMPATIBILITY

static final int COMPATIBILITY

The links in the worklist are shown like in @enterprise 6.4

See Also:

Constant Field Values

TABS

static final int TABS

The links in the worklist lead to a tabbed frame containing the forms, documents,notes, history, and process information

See Also:

Constant Field Values

TABS_WITHOUT_FORMS

static final int TABS_WITHOUT_FORMS

Detail links like in TABS, but forms are not shown in the tabbed view.

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

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

getColumns

List<ColumnDescription> getColumns()

The list of the column ids that will be shown.

Returns:

a list of strings

getLinkType

int getLinkType()

Returns how the links to the detail information are configured

Returns:

one of COMPATIBILITY, TABS, TABS_WITHOUT_FORMS

needForm

void needForm(String processid,
              int version,
              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

needForm

void needForm(ProcessDefinition pd,
              String formid)

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

Parameters:

pd - the process definition

formid - id of form

getForm

DMSForm getForm(ProcessInstance pi,
                String formid)

Get the form for a process instance

Parameters:

pi - the process instance

formid - the id of the form

Returns:

the form

getForms

Set<DMSForm> getForms(String formid)

Get all forms with a specific formid. All forms with the given id which were either preloaded declaratively in the XML GUI description or via the needForm(ProcessDefinition, String) resp. the needForm(String, int, String) call.

Can e.g. be used in Worklist.getAdditionalData(List) calls to prefetch references (cf. Store.fillByField(Class, java.util.Collection, String) and DMS.fetchSubForms(java.util.Collection, int).

Parameters:

formid - the ids of the form

Returns:

the set of forms

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.

isDelta

boolean isDelta()

Returns true, if the worklist is build only for changes (client notifications) and not as a whole

Returns:

true, if only changes are being processed.

isAugmentedItem

boolean isAugmentedItem(ActivityInstance item)

Returns true, if the ActivityInstance has been included because of augmentation. For an item included by the build-in mechanism, the call returns false. Works only for items passed to the getList() call.

Parameters:

item - the ActivityInstance to test

Returns:

true is the item is an "augmented" one

getAttrib

String getAttrib(String key)

get an attribute from the xml description