org.csapi.jr.se.ui
Interface UIManager

All Superinterfaces:
CsapiInterface, java.io.Serializable, Service

public interface UIManager
extends Service

This interface represents a UIManager.


Field Summary
 
Fields inherited from interface org.csapi.jr.se.Service
IN_SERVICE_STATE, OUT_OF_SERVICE_STATE
 
Method Summary
 void addUIManagerListener(org.csapi.jr.se.ui.UIManagerListener uIManagerListener)
          Adds a UIManagerListener which is interested in events generated by the UIManager.
 org.csapi.jr.se.ui.Notification createNotification()
          Creates a Notification object and returns a reference to the interface used to gain access to it's methods.
 org.csapi.jr.se.ui.Notifications createNotifications()
          Creates a Notifications object and returns a reference to the interface used to gain access to it's methods.
 org.csapi.jr.se.ui.UI createUI(org.csapi.jr.se.Address userAddress)
          Invokes the createUI() method on the Parlay Gateway and returns a reference to a transient interface.
 org.csapi.jr.se.ui.UICall createUICall(org.csapi.jr.se.ui.UITargetObject uiTargetObject)
          Invokes the createUICall() method on the Parlay Gateway and returns a reference to a transient interface.
 void disableNotifications()
          Invokes the disableNotifications() method on the Parlay Gateway.
 org.csapi.jr.se.ui.UIEventCriteriaResult[] getNotification()
          Invokes the getNotification() method on the Parlay Gateway.
 void removeUIManagerListener(org.csapi.jr.se.ui.UIManagerListener uIManagerListener)
          Removes a UIManagerListener which is no longer interested in events generated by the UIManager.
 
Methods inherited from interface org.csapi.jr.se.Service
addServiceStateChangeListener, getServiceState, removeServiceStateChangeListener, setCallback
 

Method Detail

addUIManagerListener

public void addUIManagerListener(org.csapi.jr.se.ui.UIManagerListener uIManagerListener)
Adds a UIManagerListener which is interested in events generated by the UIManager.

Parameters:
uIManagerListener - A reference to the UIManagerListener which is to be added as a listener.

removeUIManagerListener

public void removeUIManagerListener(org.csapi.jr.se.ui.UIManagerListener uIManagerListener)
Removes a UIManagerListener which is no longer interested in events generated by the UIManager.

Parameters:
uIManagerListener - A reference to the UIManagerListener which is to be removed as a listener.

getNotification

public org.csapi.jr.se.ui.UIEventCriteriaResult[] getNotification()
                                                           throws PlatformException,
                                                                  CommonException
Invokes the getNotification() method on the Parlay Gateway.

PlatformException
CommonException

disableNotifications

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

PlatformException
CommonException

createUI

public org.csapi.jr.se.ui.UI createUI(org.csapi.jr.se.Address userAddress)
                               throws PlatformException,
                                      CommonException,
                                      InvalidNetworkStateException,
                                      InvalidInterfaceTypeException
Invokes the createUI() method on the Parlay Gateway and returns a reference to a transient interface.

PlatformException
CommonException
InvalidNetworkStateException
InvalidInterfaceTypeException

createUICall

public org.csapi.jr.se.ui.UICall createUICall(org.csapi.jr.se.ui.UITargetObject uiTargetObject)
                                       throws PlatformException,
                                              CommonException,
                                              InvalidNetworkStateException,
                                              InvalidInterfaceTypeException
Invokes the createUICall() method on the Parlay Gateway and returns a reference to a transient interface.

PlatformException
CommonException
InvalidNetworkStateException
InvalidInterfaceTypeException

createNotifications

public org.csapi.jr.se.ui.Notifications createNotifications()
Creates a Notifications object and returns a reference to the interface used to gain access to it's methods.

Returns:
A reference to the Notifications interface.

createNotification

public org.csapi.jr.se.ui.Notification createNotification()
Creates a Notification object and returns a reference to the interface used to gain access to it's methods.

Returns:
A reference to the Notification interface.