org.csapi.jr.se.ui
Interface UI

All Superinterfaces:
CsapiInterface, java.io.Serializable, Service
All Known Subinterfaces:
UICall, UIGeneric

public interface UI
extends Service

This interface represents a UI.


Field Summary
 
Fields inherited from interface org.csapi.jr.se.Service
IN_SERVICE_STATE, OUT_OF_SERVICE_STATE
 
Method Summary
 void addUIListener(org.csapi.jr.se.ui.UIListener uIListener)
          Adds a UIListener which is interested in events generated by the UI.
 java.lang.String getOriginatingAddress()
          Invokes the getOriginatingAddress() method on the Parlay Gateway.
 org.csapi.jr.se.ui.UIManager getUIManager()
          Returns a reference to the UIManager responsible for creation of the UI.
 void release()
          Invokes the release() method on the Parlay Gateway.
 void removeUIListener(org.csapi.jr.se.ui.UIListener uIListener)
          Removes a UIListener which is no longer interested in events generated by the UI.
 void setOriginatingAddress(java.lang.String origin)
          Invokes the setOriginatingAddress() method on the Parlay Gateway.
 
Methods inherited from interface org.csapi.jr.se.Service
addServiceStateChangeListener, getServiceState, removeServiceStateChangeListener, setCallback
 

Method Detail

addUIListener

public void addUIListener(org.csapi.jr.se.ui.UIListener uIListener)
Adds a UIListener which is interested in events generated by the UI.

Parameters:
uIListener - A reference to the UIListener which is to be added as a listener.

removeUIListener

public void removeUIListener(org.csapi.jr.se.ui.UIListener uIListener)
Removes a UIListener which is no longer interested in events generated by the UI.

Parameters:
uIListener - A reference to the UIListener which is to be removed as a listener.

getUIManager

public org.csapi.jr.se.ui.UIManager getUIManager()
Returns a reference to the UIManager responsible for creation of the UI.

Returns:
A reference to the UIManager responsible for creation of the UI.

release

public void release()
             throws PlatformException,
                    CommonException
Invokes the release() method on the Parlay Gateway.

PlatformException
CommonException

setOriginatingAddress

public void setOriginatingAddress(java.lang.String origin)
                           throws PlatformException,
                                  CommonException,
                                  InvalidNetworkStateException,
                                  InvalidAddressException
Invokes the setOriginatingAddress() method on the Parlay Gateway.

PlatformException
CommonException
InvalidNetworkStateException
InvalidAddressException

getOriginatingAddress

public java.lang.String getOriginatingAddress()
                                       throws PlatformException,
                                              CommonException,
                                              InvalidNetworkStateException
Invokes the getOriginatingAddress() method on the Parlay Gateway.

PlatformException
CommonException
InvalidNetworkStateException