ALBPM Process API

fuego.papi
Class InstanceItemState

java.lang.Object
  extended by fuego.papi.InstanceItemState
All Implemented Interfaces:
fuego.lang.EnumType

public class InstanceItemState
extends Object
implements fuego.lang.EnumType

Enumeration of Instance Item State (Task).
Contains all valid status values for a process instance item.

The valid values are


Field Summary
static int ACTIVITY_COMPLETED
          All Task of the activity was executed.
static int COMPLETED
          Task completed.
static int FAILED
          Task failed.
static int INSTANCE_ROUTED
          Instance routed
static int PENDING
          Task pending to execute.
static int RUNNING
          Task running.
static int SELECTED
          Task selected.
static int WAS_COMPLETED
          Repeatable task executed.
 
Constructor Summary
InstanceItemState()
           
 
Method Summary
static String getDescription(int state, Locale locale)
          Gets the localize description of the specified state number.
static String getId(int val)
          Gets the Id of the specified state number.
static String getName(int val)
          Gets the name of the specified state number.
static boolean is(int state, int mask)
          Returns if the mask contains the instance state number.
static int valueOf(String id)
          Returns the state number for the specified state Id.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

PENDING

public static final int PENDING
Task pending to execute.

See Also:
Constant Field Values

FAILED

public static final int FAILED
Task failed. The task was executed and failed the execution.

See Also:
Constant Field Values

INSTANCE_ROUTED

public static final int INSTANCE_ROUTED
Instance routed

See Also:
Constant Field Values

COMPLETED

public static final int COMPLETED
Task completed.

See Also:
Constant Field Values

SELECTED

public static final int SELECTED
Task selected.

See Also:
Constant Field Values

RUNNING

public static final int RUNNING
Task running. The task is executing.

See Also:
Constant Field Values

ACTIVITY_COMPLETED

public static final int ACTIVITY_COMPLETED
All Task of the activity was executed.

See Also:
Constant Field Values

WAS_COMPLETED

public static final int WAS_COMPLETED
Repeatable task executed.

See Also:
Constant Field Values
Constructor Detail

InstanceItemState

public InstanceItemState()
Method Detail

getDescription

public static String getDescription(int state,
                                    Locale locale)
Gets the localize description of the specified state number.

Parameters:
state - state to obtain which description.
locale - the desired locale.
Returns:
localized description of the given state.

getId

public static String getId(int val)
Gets the Id of the specified state number.

Parameters:
val - state number to check.
Returns:
State Id

getName

public static String getName(int val)
Gets the name of the specified state number.

Parameters:
val - state number to check.
Returns:
State Name.

is

public static boolean is(int state,
                         int mask)
Returns if the mask contains the instance state number.

Parameters:
state - state to check.
mask - mask to check.
Returns:
true if the mask contains the state number.

valueOf

public static int valueOf(String id)
Returns the state number for the specified state Id.

Parameters:
id - state Id to check.
Returns:
State number

ALBPM Process API

© Copyright 1996/2005 Fuego Inc. All Rights Reserved