com.groiss.wf

Enum WorklistKind

java.lang.Object

java.lang.Enum<WorklistKind>

com.groiss.wf.WorklistKind

All Implemented Interfaces:

DefinedEnum, Serializable, Comparable<WorklistKind>

public enum WorklistKind
extends Enum<WorklistKind>
implements DefinedEnum

Specifies the kind of items of worklist (which items are to be included). For use in the WfEngine.getWorkList(WorklistKind, com.groiss.org.Application) call and in combined form as EnumSet in the WfEngine.getWorkList(java.util.EnumSet, com.groiss.org.Application) call. The worklist nodes in the standard GUI (standard.xml) are defined as

• USER
• ROLE
• SUBST_USER
• SUSP_NO_SUBST
• ROLESUSP+SUSP_ONLY_SUBST

Enum Constant Summary

Enum Constants

Enum Constant and Description
AUGMENTED An entry for customized content where the task list may not only be filtered (task being removed) but also augmented with additional tasks Is empty if not filled by application code.
NONE A "fictional" worklist.
ROLE The role worklist.
ROLE_NO_SUBST The role worklist without substitutions.
ROLESUSP The rolesuspension worklist.
ROLESUSP_NO_SUBST The direct rolesuspension worklist.
SUBST_USER The worklist of substituted users.
SUSP The suspension worklist.
SUSP_NO_SUBST The direct suspension worklist.
SUSP_ONLY_SUBST The suspension worklist for substituted users.
USER The user worklist.

Method Summary

Modifier and Type	Method and Description
Integer	definedValue() Get the fixed value for this DefinedEnum.
boolean	includedIn(int worklistType) Checks, if the passed worklist type includes this WorklistKind
static WorklistKind	valueOf(String name) Returns the enum constant of this type with the specified name.
static WorklistKind[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

NONE

public static final WorklistKind NONE

A "fictional" worklist. Does not contain any items. Must be defined via the Worklist implementation.

ROLE

public static final WorklistKind ROLE

The role worklist. Contains the (unsuspended) items assigned to the current user via her roles, including the items assigned via role substitution (those items that are assigned to roles that the current user substitutes). c.f. WfEngine.getRoleWorklist(com.groiss.org.Application)

SUSP

public static final WorklistKind SUSP

The suspension worklist. Contains the suspended items assigned directly to the current user, including suspended items assigned to users that are personally substituted by the current user.

ROLESUSP

public static final WorklistKind ROLESUSP

The rolesuspension worklist. Contains the suspended items assigned to the current user via her roles, including the items assigned via role substitution (those that are assigned to roles that the current user substitutes).

USER

public static final WorklistKind USER

The user worklist. Contains the (unsuspended) items assigned directly to the current user. c.f. WfEngine.getWorklist(com.groiss.org.Application, boolean) using false for withRepr}

ROLE_NO_SUBST

public static final WorklistKind ROLE_NO_SUBST

The role worklist without substitutions. Contains the (unsuspended) items for roles which are directly assigned to the current user.

SUSP_NO_SUBST

public static final WorklistKind SUSP_NO_SUBST

The direct suspension worklist. Contains the suspended items assigned directly to the current user. c.f. WfEngine.getSuspensionList(com.groiss.org.Application)

ROLESUSP_NO_SUBST

public static final WorklistKind ROLESUSP_NO_SUBST

The direct rolesuspension worklist. Contains the suspended items items for roles which are directly assigned to the current user. c.f. WfEngine.getRoleSuspensionList(com.groiss.org.Application)

SUBST_USER

public static final WorklistKind SUBST_USER

The worklist of substituted users. Contains the (unsuspended) items assigned to users that are personally substituted by the current user.

SUSP_ONLY_SUBST

public static final WorklistKind SUSP_ONLY_SUBST

The suspension worklist for substituted users. Contains the suspended items assigned to users that are personally substituted by the current user.

AUGMENTED

public static final WorklistKind AUGMENTED

An entry for customized content where the task list may not only be filtered (task being removed) but also augmented with additional tasks Is empty if not filled by application code.

Method Detail

values

public static WorklistKind[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (WorklistKind c : WorklistKind.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static WorklistKind valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

definedValue

public Integer definedValue()

Description copied from interface: DefinedEnum

Get the fixed value for this DefinedEnum. At the moment, Strings, Shorts, Integers and Longs are supported.

Specified by:

definedValue in interface DefinedEnum

Returns:

the fixed value

includedIn

public boolean includedIn(int worklistType)

Checks, if the passed worklist type includes this WorklistKind

Parameters:

worklistType - the type to check for inclusion

Returns:

true, if the this WorklistKind is included in the passed worklistType