JSR-043: JTAPI-1.4

javax.telephony.callcontrol
Interface CallControlAddressEvent

All Superinterfaces:
AddressEvent, CallControlEvent, Event

public interface CallControlAddressEvent
extends CallControlEvent, AddressEvent

The CallControlAddressEvent interface is the base interface for all callcontrol package Address-related events. All CallControlAddress-related events must extend this interface. Events which extend this interface are reported via the CallControlAddressListener interface. This interface extends both the CallControlEvent and core AddressEvent interfaces.

Since:
1.4
See Also:
Address, AddressEvent, AddressListener, CallControlAddressListener, CallControlEvent

Field Summary
static int CALLCTL_ADDRESS_EVENT_DO_NOT_DISTURB
          The CALLCTL_ADDRESS_EVENT_DO_NOT_DISTURB event indicates that the state of the do not disturb feature has changed for the Address.
static int CALLCTL_ADDRESS_EVENT_FORWARD
          The CALLCTL_ADDRESS_EVENT_FORWARD event indicates that the state of the forward feature has changed for the Address.
static int CALLCTL_ADDRESS_EVENT_MESSAGE_WAITING
          The CALLCTL_ADDRESS_EVENT_MESSAGE_WAITING event indicates that the state of the message waiting feature has changed for the Address.
 
Fields inherited from interface javax.telephony.callcontrol.CallControlEvent
CAUSE_ALTERNATE, CAUSE_BUSY, CAUSE_CALL_BACK, CAUSE_CALL_NOT_ANSWERED, CAUSE_CALL_PICKUP, CAUSE_CONFERENCE, CAUSE_DO_NOT_DISTURB, CAUSE_PARK, CAUSE_REDIRECTED, CAUSE_REORDER_TONE, CAUSE_TRANSFER, CAUSE_TRUNKS_BUSY, CAUSE_UNHOLD
 
Fields inherited from interface javax.telephony.Event
CAUSE_CALL_CANCELLED, CAUSE_DEST_NOT_OBTAINABLE, CAUSE_INCOMPATIBLE_DESTINATION, CAUSE_LOCKOUT, CAUSE_NETWORK_CONGESTION, CAUSE_NETWORK_NOT_OBTAINABLE, CAUSE_NEW_CALL, CAUSE_NORMAL, CAUSE_RESOURCES_NOT_AVAILABLE, CAUSE_SNAPSHOT, CAUSE_UNKNOWN
 
Fields inherited from interface javax.telephony.AddressEvent
ADDRESS_EVENT_TRANSMISSION_ENDED
 
Method Summary
 boolean getDoNotDisturbState()
          Returns true if the do not disturb feature is activated, false otherwise.
 CallControlForwarding[] getForwarding()
          Returns the current forwarding on the Address.
 boolean getMessageWaitingState()
          Returns the current message waiting state of the Address.
 
Methods inherited from interface javax.telephony.callcontrol.CallControlEvent
getCallControlCause
 
Methods inherited from interface javax.telephony.Event
getCause, getID, getMetaEvent, getSource
 
Methods inherited from interface javax.telephony.AddressEvent
getAddress
 

Field Detail

CALLCTL_ADDRESS_EVENT_DO_NOT_DISTURB

public static final int CALLCTL_ADDRESS_EVENT_DO_NOT_DISTURB
The CALLCTL_ADDRESS_EVENT_DO_NOT_DISTURB event indicates that the state of the do not disturb feature has changed for the Address.

This constant indicates a specific event passed via the CallControlAddressEvent event, and is reported on the CallControlAddressListener interface by calling the CallControlAddressListener.addressDoNotDisturb( CallControlAddressEvent ) method. The new state of the do not disturb feature can be gotten by the getDoNotDisturb() method on the CallControlAddress


CALLCTL_ADDRESS_EVENT_FORWARD

public static final int CALLCTL_ADDRESS_EVENT_FORWARD
The CALLCTL_ADDRESS_EVENT_FORWARD event indicates that the state of the forward feature has changed for the Address.

This constant indicates a specific event passed via the CallControlAddressEvent event, and is reported on the CallControlAddressListener interface by calling the CallControlAddressListener.addressForwarded( CallControlAddressEvent ) method. The new state of the forward feature can be gotten by the getForwarding() method on the CallControlAddress


CALLCTL_ADDRESS_EVENT_MESSAGE_WAITING

public static final int CALLCTL_ADDRESS_EVENT_MESSAGE_WAITING
The CALLCTL_ADDRESS_EVENT_MESSAGE_WAITING event indicates that the state of the message waiting feature has changed for the Address.

This constant indicates a specific event passed via the CallControlAddressEvent event, and is reported on the CallControlAddressListener interface by calling the CallControlAddressListener.addressMessageWaiting( CallControlAddressEvent ) method. The new state of the message waiting feature can gotten by the getMessageWaiting() method on the CallControlAddress

Method Detail

getDoNotDisturbState

public boolean getDoNotDisturbState()
Returns true if the do not disturb feature is activated, false otherwise.

Returns:
True if the do not disturb feature is activated, false otherwise.

getForwarding

public CallControlForwarding[] getForwarding()
Returns the current forwarding on the Address.

Returns:
An array of CallControlForwarding objects.

getMessageWaitingState

public boolean getMessageWaitingState()
Returns the current message waiting state of the Address.

Returns:
The message waiting state of the Address.

JSR-043: JTAPI-1.4

Send comments to: JSR-43@ectf.org