org.asteriskjava.live
Enum QueueMemberState

java.lang.Object
  java.lang.Enum<QueueMemberState>
      org.asteriskjava.live.QueueMemberState

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<QueueMemberState>

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

Represents the status of a Queue memeber.

Valid status codes are:

AST_DEVICE_UNKNOWN (0)

Queue member is available

AST_DEVICE_NOT_INUSE (1)

?

AST_DEVICE_INUSE (2)

?

AST_DEVICE_BUSY (3)

?

AST_DEVICE_INVALID (4)

?

AST_DEVICE_UNAVAILABLE (5)

?

Since:

0.3.1

Version:

$Id: QueueMemberState.java 962 2008-02-03 03:34:11Z srt $

Author:

Patrick Breucking

See Also:

QueueMemberEvent

Enum Constant Summary

DEVICE_BUSY
Busy means, phone is in action, eg.

DEVICE_INUSE

DEVICE_INVALID

DEVICE_NOT_INUSE
Queue member is available, eg.

DEVICE_UNAVAILABLE
Device is not availible for call, eg.

DEVICE_UNKNOWN

Method Summary

int	getStatus() Returns the numerical status code.
static QueueMemberState	valueOf(java.lang.Integer status) Returns value specified by int.
static QueueMemberState	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static QueueMemberState[]	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

DEVICE_UNKNOWN

public static final QueueMemberState DEVICE_UNKNOWN

DEVICE_NOT_INUSE

public static final QueueMemberState DEVICE_NOT_INUSE

Queue member is available, eg. Agent is logged in but idle.

DEVICE_INUSE

public static final QueueMemberState DEVICE_INUSE

DEVICE_BUSY

public static final QueueMemberState DEVICE_BUSY

Busy means, phone is in action, eg. is ringing, in call.

DEVICE_INVALID

public static final QueueMemberState DEVICE_INVALID

DEVICE_UNAVAILABLE

public static final QueueMemberState DEVICE_UNAVAILABLE

Device is not availible for call, eg. Agent is logged off.

Method Detail

values

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

Returns:

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

valueOf

public static QueueMemberState 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

getStatus

public int getStatus()

Returns the numerical status code.

Returns:

the numerical status code.

See Also:

QueueMemberEvent.getStatus()

valueOf

public static QueueMemberState valueOf(java.lang.Integer status)

Returns value specified by int. Use this to transform QueueMemberEvent.getStatus().

Parameters:

status - integer representation of the status.

Returns:

corresponding QueueMemberState object or null if none matches.