Asterisk-Java

org.asteriskjava.live
Enum AgentState

java.lang.Object
  extended by java.lang.Enum<AgentState>
      extended by org.asteriskjava.live.AgentState
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<AgentState>

public enum AgentState
extends java.lang.Enum<AgentState>

The lifecycle status of an AsteriskAgent.

Since:
0.3.1
Version:
$Id: AgentState.java 962 2008-02-03 03:34:11Z srt $
Author:
Patrick Breucking

Enum Constant Summary
AGENT_IDLE
          Agent is logged in and waiting for call.
AGENT_LOGGEDOFF
          Agent isn't logged in.
AGENT_ONCALL
          Agent is logged in and on a call.
AGENT_RINGING
          Agent is logged in and a call is waiting for connect.
AGENT_UNKNOWN
          Don't know anything about agent.
 
Method Summary
static AgentState valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static AgentState[] 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

AGENT_LOGGEDOFF

public static final AgentState AGENT_LOGGEDOFF
Agent isn't logged in.


AGENT_IDLE

public static final AgentState AGENT_IDLE
Agent is logged in and waiting for call.


AGENT_ONCALL

public static final AgentState AGENT_ONCALL
Agent is logged in and on a call.


AGENT_UNKNOWN

public static final AgentState AGENT_UNKNOWN
Don't know anything about agent. Shouldn't ever get this.


AGENT_RINGING

public static final AgentState AGENT_RINGING
Agent is logged in and a call is waiting for connect.

Method Detail

values

public static AgentState[] 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 (AgentState c : AgentState.values())
    System.out.println(c);

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

valueOf

public static AgentState valueOf(java.lang.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:
java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
java.lang.NullPointerException - if the argument is null

Asterisk-Java

Copyright © 2004-2009 Stefan Reuter. All Rights Reserved.