org.asteriskjava.manager.event

Class ResponseEvent

java.lang.Object

java.util.EventObject

org.asteriskjava.manager.event.ManagerEvent

org.asteriskjava.manager.event.ResponseEvent

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

AgentsCompleteEvent, AgentsEvent, AsyncAgiEvent, ConfbridgeListCompleteEvent, ConfbridgeListEvent, ConfbridgeListRoomsCompleteEvent, ConfbridgeListRoomsEvent, CoreShowChannelEvent, CoreShowChannelsCompleteEvent, DahdiShowChannelsCompleteEvent, DahdiShowChannelsEvent, DbGetResponseEvent, DongleDeviceEntryEvent, DongleShowDevicesCompleteEvent, ListDialplanEvent, OriginateResponseEvent, ParkedCallsCompleteEvent, PeerEntryEvent, PeerlistCompleteEvent, PeersEvent, QueueEntryEvent, QueueMemberEvent, QueueParamsEvent, QueueStatusCompleteEvent, QueueSummaryCompleteEvent, QueueSummaryEvent, RegistrationsCompleteEvent, RegistryEntryEvent, ShowDialplanCompleteEvent, SkypeBuddyEntryEvent, SkypeBuddyListCompleteEvent, SkypeLicenseEvent, SkypeLicenseListCompleteEvent, StatusCompleteEvent, StatusEvent, VoicemailUserEntryCompleteEvent, VoicemailUserEntryEvent, ZapShowChannelsCompleteEvent, ZapShowChannelsEvent

public abstract class ResponseEvent
extends ManagerEvent

Abstract base class for events triggered in response to a ManagerAction.

All ResponseEvents contain an additional action id property that links the event to the action that caused it.

Version:

$Id$

Author:

srt

See Also:

ManagerAction, Serialized Form

Field Summary

Fields inherited from class org.asteriskjava.manager.event.ManagerEvent

callerIdName, callerIdNum, channelState, channelStateDesc, connectedLineName, connectedLineNum, context, exten, priority

Fields inherited from class java.util.EventObject

source

Constructor Summary

Constructors

Constructor and Description
ResponseEvent(Object source)

Method Summary

Modifier and Type	Method and Description
String	getActionId() Returns the user provided action id of the ManagerAction that caused this event.
String	getInternalActionId() Returns the internal action id of the ManagerAction that caused this event.
void	setActionId(String actionId) Sets the action id of the ManagerAction that caused this event.
void	setInternalActionId(String internalActionId) Sets the internal action id of the ManagerAction that caused this event.

Methods inherited from class org.asteriskjava.manager.event.ManagerEvent

appendPropertyIfNotNull, getCallerIdName, getCallerIdNum, getChannelState, getChannelStateDesc, getConnectedLineName, getConnectedLineNum, getContext, getDateReceived, getExten, getFile, getFunc, getLine, getPriority, getPrivilege, getSequenceNumber, getServer, getSystemName, getTimestamp, setCallerIdName, setCallerIdNum, setChannelState, setChannelStateDesc, setConnectedLineName, setConnectedLineNum, setContext, setDateReceived, setExten, setFile, setFunc, setLine, setPriority, setPrivilege, setSequenceNumber, setServer, setSystemName, setTimestamp, 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

ResponseEvent

public ResponseEvent(Object source)

Method Detail

getActionId

public final String getActionId()

Returns the user provided action id of the ManagerAction that caused this event. If the application did not set an action id this method returns null.

Returns:

the action id of the ManagerAction that caused this event or null if none was set.

See Also:

ManagerAction.setActionId(String)

setActionId

public final void setActionId(String actionId)

Sets the action id of the ManagerAction that caused this event.

Parameters:

actionId - the action id of the ManagerAction that caused this event.

getInternalActionId

public final String getInternalActionId()

Returns the internal action id of the ManagerAction that caused this event.

Warning: This method is internal to Asterisk-Java and should never be used in application code.

Returns:

the internal action id of the ManagerAction that caused this event.

Since:

0.2

setInternalActionId

public final void setInternalActionId(String internalActionId)

Sets the internal action id of the ManagerAction that caused this event.

Parameters:

internalActionId - the internal action id of the ManagerAction that caused this event.

Since:

0.2