net.sf.asterisk.manager.event
Class ChannelEvent

java.lang.Object
  java.util.EventObject
      net.sf.asterisk.manager.event.ManagerEvent
          net.sf.asterisk.manager.event.ChannelEvent

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

HangupEvent, NewChannelEvent, NewStateEvent

public abstract class ChannelEvent
extends ManagerEvent

Abstract base class providing common properties for HangupEvent, NewChannelEvent and NewStateEvent.

Version:

$Id: ChannelEvent.java,v 1.4 2005/02/26 20:50:31 srt Exp $

Author:

srt

See Also:

Serialized Form

Field Summary

Fields inherited from class java.util.EventObject

source

Constructor Summary

ChannelEvent(java.lang.Object source)

Method Summary

java.lang.String	getCallerId() Returns the Caller*ID of the channel if set or "≶unknown>" if none has been set.
java.lang.String	getCallerIdName() Returns the Caller*ID Name of the channel if set or "≶unknown>" if none has been set.
java.lang.String	getChannel() Returns the name of the channel.
java.lang.String	getState() Returns the (new) state of the channel. The following states are used: Down OffHook Dialing Ring Ringing Up Busy
java.lang.String	getUniqueId() Returns the unique id of the channel.
void	setCallerId(java.lang.String callerId) Sets the Caller*ID of the channel.
void	setCallerIdName(java.lang.String callerIdName) Sets the Caller*ID Name of the channel.
void	setChannel(java.lang.String channel) Sets the name of the channel.
void	setState(java.lang.String state) Sets the (new) state of the channel.
void	setUniqueId(java.lang.String uniqueId) Sets the unique id of the channel.

Methods inherited from class net.sf.asterisk.manager.event.ManagerEvent

getDateReceived, getPrivilege, setDateReceived, setPrivilege, toString

Methods inherited from class java.util.EventObject

getSource

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ChannelEvent

public ChannelEvent(java.lang.Object source)

Parameters:

source -

Method Detail

getChannel

public java.lang.String getChannel()

Returns the name of the channel.

setChannel

public void setChannel(java.lang.String channel)

Sets the name of the channel.

getUniqueId

public java.lang.String getUniqueId()

Returns the unique id of the channel.

setUniqueId

public void setUniqueId(java.lang.String uniqueId)

Sets the unique id of the channel.

getCallerId

public java.lang.String getCallerId()

Returns the Caller*ID of the channel if set or "≶unknown>" if none has been set.

setCallerId

public void setCallerId(java.lang.String callerId)

Sets the Caller*ID of the channel.

Parameters:

callerId - the Caller*ID of the channel.

getCallerIdName

public java.lang.String getCallerIdName()

Returns the Caller*ID Name of the channel if set or "≶unknown>" if none has been set.

Returns:

the Caller*ID Name of the channel.

setCallerIdName

public void setCallerIdName(java.lang.String callerIdName)

Sets the Caller*ID Name of the channel.

Parameters:

callerIdName - the Caller*ID Name of the channel.

getState

public java.lang.String getState()

Returns the (new) state of the channel.
The following states are used:

• Down
• OffHook
• Dialing
• Ring
• Ringing
• Up
• Busy

setState

public void setState(java.lang.String state)

Sets the (new) state of the channel.