Asterisk-Java

org.asteriskjava.manager.event
Class ResponseEvent

java.lang.Object
  extended by java.util.EventObject
      extended by org.asteriskjava.manager.event.ManagerEvent
          extended by org.asteriskjava.manager.event.ResponseEvent
All Implemented Interfaces:
java.io.Serializable
Direct Known Subclasses:
AgentsCompleteEvent, AgentsEvent, AsyncAgiEvent, DbGetResponseEvent, ListDialplanEvent, OriginateResponseEvent, ParkedCallsCompleteEvent, PeerEntryEvent, PeerlistCompleteEvent, QueueEntryEvent, QueueMemberEvent, QueueParamsEvent, QueueStatusCompleteEvent, QueueSummaryCompleteEvent, QueueSummaryEvent, RegistrationsCompleteEvent, RegistryEntryEvent, ShowDialplanCompleteEvent, 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: ResponseEvent.java 976 2008-02-03 22:08:11Z srt $
Author:
srt
See Also:
ManagerAction, Serialized Form

Field Summary
 
Fields inherited from class java.util.EventObject
source
 
Constructor Summary
ResponseEvent(java.lang.Object source)
           
 
Method Summary
 java.lang.String getActionId()
          Returns the user provided action id of the ManagerAction that caused this event.
 java.lang.String getInternalActionId()
          Returns the internal action id of the ManagerAction that caused this event.
 void setActionId(java.lang.String actionId)
          Sets the action id of the ManagerAction that caused this event.
 void setInternalActionId(java.lang.String internalActionId)
          Sets the internal action id of the ManagerAction that caused this event.
 
Methods inherited from class org.asteriskjava.manager.event.ManagerEvent
getDateReceived, getPrivilege, getServer, getTimestamp, setDateReceived, setPrivilege, setServer, 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(java.lang.Object source)
Method Detail

getActionId

public java.lang.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 void setActionId(java.lang.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 java.lang.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 void setInternalActionId(java.lang.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

Asterisk-Java

Copyright © 2004-2009 Stefan Reuter. All Rights Reserved.