javax.telephony.callcontrol
Class CallControlForwarding

java.lang.Object
  |
  +--javax.telephony.callcontrol.CallControlForwarding

public class CallControlForwarding

extends java.lang.Object

The CallControlForwarding class represents a forwarding instruction. This instruction tells how the platform should forward incoming telephone calls to a specific address. There are several attributes to a forwarding instruction.

The first attribute is its type. The forwarding instruction's type tells the platform when to forward the call. There are currently three types of instructions: telling the platform to always forward incoming calls, telling the platform to forward incoming calls when the address is busy, and telling the platform to forward incoming calls when no one answers.

The second attribute of a forwarding instruction is its filter. The filter indicates which type of incoming calls this forwarding instruction should apply to. This forwarding instruction can apply to all calls, to external calls only, to internal calls only, or to a specific calling address.

Field Summary

static int	ALL_CALLS Forwarding filter: apply instruction to all incoming calls.
static int	EXTERNAL_CALLS Forwarding filter: apply instruction to calls originating from outside the provider domain.
static int	FORWARD_ON_BUSY Forwarding type: forward calls on busy.
static int	FORWARD_ON_NOANSWER Forwarding type: forward calls on no answer.
static int	FORWARD_UNCONDITIONALLY Forwarding type: forward calls unconditionally.
static int	INTERNAL_CALLS Forwarding filter: apply instruction to calls originating from the provider domain.
static int	SPECIFIC_ADDRESS Forwarding filter: apply instruction to calls originating from a specific address.

Constructor Summary

CallControlForwarding(java.lang.String destAddress)
This constructor is the default constructor, which only takes the address to apply this forwarding instruction.

CallControlForwarding(java.lang.String destAddress, int type)
This constructor takes the address to apply this forwarding instruction and the type of forwarding for all incoming calls.

CallControlForwarding(java.lang.String destAddress, int type, boolean internalCalls)
This constructor takes the address to apply this forwarding instruction, the type of forwarding desired for this address, and a boolean flag indicating whether this instruction should apply to internal (true) or external (false) calls.

CallControlForwarding(java.lang.String destAddress, int type, java.lang.String caller)
This constructor takes an address to apply the forwarding instruction for a specific incoming telephone call, identified by a string address.

Method Summary

java.lang.String	getDestinationAddress() Returns the destination address of this forwarding instruction.
int	getFilter() Returns the filter of this forwarding instruction.
java.lang.String	getSpecificCaller() If the filter for this forwarding instruction is SPECIFIC_ADDRESS, then this method returns that calling address to which this filter applies.
int	getType() Returns the type of this forwarding instruction, either unconditionally, upon no answer, or upon busy.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ALL_CALLS

public static final int ALL_CALLS

Forwarding filter: apply instruction to all incoming calls.

INTERNAL_CALLS

public static final int INTERNAL_CALLS

Forwarding filter: apply instruction to calls originating from the provider domain.

EXTERNAL_CALLS

public static final int EXTERNAL_CALLS

Forwarding filter: apply instruction to calls originating from outside the provider domain.

SPECIFIC_ADDRESS

public static final int SPECIFIC_ADDRESS

Forwarding filter: apply instruction to calls originating from a specific address.

FORWARD_UNCONDITIONALLY

public static final int FORWARD_UNCONDITIONALLY

Forwarding type: forward calls unconditionally.

FORWARD_ON_BUSY

public static final int FORWARD_ON_BUSY

Forwarding type: forward calls on busy.

FORWARD_ON_NOANSWER

public static final int FORWARD_ON_NOANSWER

Forwarding type: forward calls on no answer.

Constructor Detail

CallControlForwarding

public CallControlForwarding(java.lang.String destAddress)

This constructor is the default constructor, which only takes the address to apply this forwarding instruction. The forwarding instruction forwards all calls unconditionally.

Parameters:

destAddress - destination address for the call forwarding operation

CallControlForwarding

public CallControlForwarding(java.lang.String destAddress,
                             int type)

This constructor takes the address to apply this forwarding instruction and the type of forwarding for all incoming calls.

Parameters:

destAddress - destination address for the call forwarding operation

type - the type of the forwarding operation

CallControlForwarding

public CallControlForwarding(java.lang.String destAddress,
                             int type,
                             boolean internalCalls)

This constructor takes the address to apply this forwarding instruction, the type of forwarding desired for this address, and a boolean flag indicating whether this instruction should apply to internal (true) or external (false) calls.

Parameters:

destAddress - destination address for the call forwarding operation

type - the type of the forwarding operation

internalCalls - flag for internal call forwarding

CallControlForwarding

public CallControlForwarding(java.lang.String destAddress,
                             int type,
                             java.lang.String caller)

This constructor takes an address to apply the forwarding instruction for a specific incoming telephone call, identified by a string address. It also takes the type of forwarding desired for this specific address.

Parameters:

destAddress - destination address for the call forwarding operation

type - the type of the forwarding operation

caller - the address of the incoming caller

Method Detail

getDestinationAddress

public java.lang.String getDestinationAddress()

Returns the destination address of this forwarding instruction.

Returns:

The destination address of this forwarding instruction.

getType

public int getType()

Returns the type of this forwarding instruction, either unconditionally, upon no answer, or upon busy.

Returns:

The type of this forwarding instruction.

getFilter

public int getFilter()

Returns the filter of this forwarding instruction. The filter indicates which calls should trigger this forwarding instruction. Filters include: applying this instruction to all calls, to only internal calls, to only external call, or for calls from a specific address.

Returns:

The filter for this forwarding instruction.

getSpecificCaller

public java.lang.String getSpecificCaller()

If the filter for this forwarding instruction is SPECIFIC_ADDRESS, then this method returns that calling address to which this filter applies. If the filter is something other than SPECIFIC_ADDRESS, this method returns null.

Returns:

The specific address for this forwarding instruction.