org.obe.client.api.model
Class TemporalStatus

java.lang.Object
  org.obe.util.AbstractEnum
      org.obe.client.api.model.TemporalStatus

All Implemented Interfaces:

java.lang.Comparable, Enum, java.io.Serializable

public final class TemporalStatus

extends AbstractEnum

The temporal status of a process instance, activity instance, or work item. Temporal status reflects whether the entity in question is ahead of schedule, behind schedule or overdue, according to its target and due dates. These are computed by the workflow engine from the entities Duration and Limit properties as defined in the XPDL.

Author:

Adrian Price

See Also:

#getLimit(), ProcessHeader.getLimit(), TimeEstimation.getDuration(), Serialized Form

Field Summary

static TemporalStatus	NORMAL
static int	NORMAL_INT
static TemporalStatus	OVERDUE
static int	OVERDUE_INT
static TemporalStatus	UNDEFINED
static int	UNDEFINED_INT
static java.util.List	VALUES
static TemporalStatus	WARNING
static int	WARNING_INT

Fields inherited from class org.obe.util.AbstractEnum

name, ordinal

Method Summary

static TemporalStatus	computeStatus(java.util.Date completed, java.util.Date target, java.util.Date due) Computes the temporal status corresponding to the set of input values.
java.util.List	family() Returns an immutable list of the members of the enumerated type.

Methods inherited from class org.obe.util.AbstractEnum

clinit, clone, compareTo, equals, hashCode, readResolve, toString, value

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

UNDEFINED_INT

public static final int UNDEFINED_INT

See Also:

Constant Field Values

NORMAL_INT

public static final int NORMAL_INT

See Also:

Constant Field Values

WARNING_INT

public static final int WARNING_INT

See Also:

Constant Field Values

OVERDUE_INT

public static final int OVERDUE_INT

See Also:

Constant Field Values

UNDEFINED

public static final TemporalStatus UNDEFINED

NORMAL

public static final TemporalStatus NORMAL

WARNING

public static final TemporalStatus WARNING

OVERDUE

public static final TemporalStatus OVERDUE

VALUES

public static final java.util.List VALUES

Method Detail

computeStatus

public static TemporalStatus computeStatus(java.util.Date completed,
                                           java.util.Date target,
                                           java.util.Date due)

Computes the temporal status corresponding to the set of input values.

Parameters:

completed - The date at which the process or task was completed (can be null).

target - The date by which the process or task is/was expected to be complete.

due - The date by which the process or task is/was required to be complete.

Returns:

Temporal status, one of: UNDEFINED, NORMAL, WARNING, OVERDUE.

family

public java.util.List family()

Description copied from interface: Enum

Returns an immutable list of the members of the enumerated type.

Returns:

The family of allowed values.