org.asteriskjava.pbx

Enum Call.OperandChannel

java.lang.Object

java.lang.Enum<Call.OperandChannel>

org.asteriskjava.pbx.Call.OperandChannel

All Implemented Interfaces:

Serializable, Comparable<Call.OperandChannel>

Enclosing interface:

Call

public static enum Call.OperandChannel
extends Enum<Call.OperandChannel>

Used to identify which channel of a call an operation is to be performed on. This is designed to stop the mis-use of some methods which operate on a specific channel of a call. The Operand allows the caller to specify which channel to operate on without having to explicitly pass in the channel. Without this enum they could potentially pass in a channel which is not owned by the call.

Author:

bsutton

Enum Constant Summary

Enum Constants

Enum Constant and Description
ACCEPTING_PARTY this party received (did not originate) the call
LOCAL_PARTY a local call is a handset attached directly (via sip) to the pbx
ORIGINATING_PARTY this party originated (dialled) the call
REMOTE_PARTY is an end point that is on an external trunk
TRANSFER_TARGET_PARTY

Method Summary

Modifier and Type	Method and Description
static Call.OperandChannel	valueOf(String name) Returns the enum constant of this type with the specified name.
static Call.OperandChannel[]	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

ACCEPTING_PARTY

public static final Call.OperandChannel ACCEPTING_PARTY

this party received (did not originate) the call

ORIGINATING_PARTY

public static final Call.OperandChannel ORIGINATING_PARTY

this party originated (dialled) the call

TRANSFER_TARGET_PARTY

public static final Call.OperandChannel TRANSFER_TARGET_PARTY

REMOTE_PARTY

public static final Call.OperandChannel REMOTE_PARTY

is an end point that is on an external trunk

LOCAL_PARTY

public static final Call.OperandChannel LOCAL_PARTY

a local call is a handset attached directly (via sip) to the pbx

Method Detail

values

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

Returns:

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

valueOf

public static Call.OperandChannel valueOf(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:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null