agent.interaction.samples
Class MultipartyVoiceInteraction

java.lang.Object
  extended by agent.interaction.samples.SimplePlace
      extended by agent.interaction.samples.SimpleVoiceInteraction
          extended by agent.interaction.samples.MultipartyVoiceInteraction
All Implemented Interfaces:
com.genesyslab.ail.event.ConfigObjectListener, com.genesyslab.ail.event.DnListener, com.genesyslab.ail.event.InteractionListener, com.genesyslab.ail.event.PlaceListener, java.util.EventListener

public class MultipartyVoiceInteraction
extends SimpleVoiceInteraction

This example uses a GUI application to show how to transfer a call and how to set up a three-way conference call.


Field Summary
 
Fields inherited from class agent.interaction.samples.SimplePlace
sampleAgent, sampleChat, sampleDn, sampleEmail, sampleOpenMedia, samplePlace
 
Constructor Summary
MultipartyVoiceInteraction(java.lang.String windowTitle)
          Creates an instance of MultipartyVoiceInteraction.
 
Method Summary
 void handleInteractionEvent(com.genesyslab.ail.event.InteractionEvent event)
          Receives InteractionEvents, which report changes to the status or data for all interactions of this place.
 void linkWidgetsToGui()
          Links widgets (user interface components) to API functionality and registers a listener for events on the Place the agent has logged in to.
static void main(java.lang.String[] args)
          This method is used to run the MultipartyVoiceInteraction example.
 void performComplete()
          Performs the Complete action associated to the Complete button.
 void performConference()
          Performs the Conference action associated with the Conference button.
 void performTransfer()
          Performs the Transfer action associated with the Transfer button.
 void setInteractionWidgetState()
          This class receives InteractionEvents, which are handled by the handleInteractionEvent() method.
 void setSampleType()
          Tells the AgentInteractionGui class which example has called the GUI, so that it can determine which widgets will be enabled when the GUI is created.
 
Methods inherited from class agent.interaction.samples.SimplePlace
contactChanged, deleted, dnAdded, dnRemoved, handleDnEvent, handlePlaceEvent, idModified, setPlaceWidgetState
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

MultipartyVoiceInteraction

public MultipartyVoiceInteraction(java.lang.String windowTitle)
Creates an instance of MultipartyVoiceInteraction.

Parameters:
windowTitle - The title of the GUI window for this example.
Method Detail

setSampleType

public void setSampleType()
Tells the AgentInteractionGui class which example has called the GUI, so that it can determine which widgets will be enabled when the GUI is created.

Overrides:
setSampleType in class SimpleVoiceInteraction

linkWidgetsToGui

public void linkWidgetsToGui()
Links widgets (user interface components) to API functionality and registers a listener for events on the Place the agent has logged in to.

The linked widgets for Multiparty Voice are buttons for starting a conference or a transfer, and to select how to process the action (single step, mute, dual step) using radio buttons.

Overrides:
linkWidgetsToGui in class SimpleVoiceInteraction
See Also:
SimplePlace.linkWidgetsToGui()

setInteractionWidgetState

public void setInteractionWidgetState()
This class receives InteractionEvents, which are handled by the handleInteractionEvent() method. This class also has widgets whose state must be set when it receives these events.

This method enables or disables the specified widgets, which are normally just buttons and radio buttons, but may include other widgets. To do this, it use the isPossible() method of the Possible interface. The isPossible() method returns either true or false, depending on whether a particular action is possible. This boolean value is used to determine whether the widget will be enabled.

Overrides:
setInteractionWidgetState in class SimpleVoiceInteraction

performConference

public void performConference()
Performs the Conference action associated with the Conference button. It takes into account the type of conference selected by the user (using toggle buttons).


performTransfer

public void performTransfer()
Performs the Transfer action associated with the Transfer button. It takes into account the type of transfer selected by the user.


performComplete

public void performComplete()
Performs the Complete action associated to the Complete button. It takes into account whether the action completes a transfer or a conference.


handleInteractionEvent

public void handleInteractionEvent(com.genesyslab.ail.event.InteractionEvent event)
Receives InteractionEvents, which report changes to the status or data for all interactions of this place. If you implement the PlaceListener interface, you must implement this method.

The MultipartyVoiceInteraction code example uses this method to log these InteractionEvents as they occur and to set the state of the widgets used by the MultipartyVoiceInteraction example.

Specified by:
handleInteractionEvent in interface com.genesyslab.ail.event.InteractionListener
Overrides:
handleInteractionEvent in class SimpleVoiceInteraction

main

public static void main(java.lang.String[] args)
This method is used to run the MultipartyVoiceInteraction example.

Parameters:
args - There are no arguments for this class.