ciagent
Class CIAgentState

java.lang.Object
  |
  +--ciagent.CIAgentState

public class CIAgentState
extends java.lang.Object
implements java.io.Serializable

The CIAgentState contains the state of an agent (UNINITIATED, INITIATED, ACTIVE, SUSPENDED, UNKNOWN).

See Also:
Serialized Form

Field Summary
static int ACTIVE
           
static int INITIATED
           
static int SUSPENDED
           
static int UNINITIATED
           
static int UNKNOWN
           
 
Constructor Summary
CIAgentState()
          Creates a CIAgentState object.
 
Method Summary
 int getState()
          Retrieves the state.
 void setState(int state)
          Sets the state.
 java.lang.String toString()
          Coverts the state to a printable format.
 
Methods inherited from class java.lang.Object
, clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

UNINITIATED

public static final int UNINITIATED

INITIATED

public static final int INITIATED

ACTIVE

public static final int ACTIVE

SUSPENDED

public static final int SUSPENDED

UNKNOWN

public static final int UNKNOWN
Constructor Detail

CIAgentState

public CIAgentState()
Creates a CIAgentState object.
Method Detail

setState

public void setState(int state)
Sets the state.
Parameters:
state - the state of an agent

getState

public int getState()
Retrieves the state.
Returns:
an integer that represents the state

toString

public java.lang.String toString()
Coverts the state to a printable format.
Returns:
a formatted String that represents the state
Overrides:
toString in class java.lang.Object