cvm.uci.handlers
Class UCIEventObjectManager

java.lang.Object
  cvm.uci.handlers.UCIEventObjectManager

public class UCIEventObjectManager
extends java.lang.Object

This class handles the firing of events for UCM. Date: January 29, 2010

Author:

Frank Hernandez

Method Summary

void	addDownListener(java.util.EventListener listener) Deprecated.
void	addUpListener(Uses_Listener listener) Adds listener on this object.
void	fireUpEvent(Handles_Event event) General Event Trigger.
static UCIEventObjectManager	getInstance() Implementation of the Instance method as in the singleton design pattern.
void	notifyDataSchemaReceived(NegotiationSchema negSchema) Event notification function.
void	notifyGUIAddFileToCommunication_Event(java.lang.String connID, java.lang.String fileName) Event notifier function.
void	notifyGUIAddFormToCommunication_Event(java.lang.String commID, java.lang.String formName) Event notification function.
void	notifyGUIAddParticipantToComm_Event(java.lang.String connID, java.lang.String userName) Event notification function.
void	notifyGUICloseApp_Event(java.lang.String appID) Event notifier function.
void	notifyGUICreationFormPanelOpen_Event() Event notification function.
void	notifyGUIExpandView_Event() Event notification function.
void	notifyGUIFormPanelClear_Event() Event notifier function.
void	notifyGUIFormPanelClose_Event() Event notifier function.
void	notifyGUIHideView_Event() Event notification function.
void	notifyGUIMyAppPanelRefresh_Event() Event notifier function.
void	notifyGUIMyFormsPanelRefresh_Event() Event notifier function.
void	notifyGUINewCallStarted_Event(java.lang.String commID, java.lang.String appName) Event notifier function.
void	notifyGUIOpenForm_Event(java.lang.String formName) Event notifier function.
void	notifyGUIRemoveParticipantFromComm_Event(java.lang.String connID, java.lang.String userName) Event notification function.
void	notifyGUIShowChat_Event(java.lang.String connID, java.lang.String userName, java.lang.String message) Event notification function.
void	notifyGUISidePanelToggle_Event() Event notifier function.
void	notifyUCIContactRemoved_Event(java.lang.String userName) Event notification function.
void	notifyUCIControlSchemaReceived(java.lang.String ctrSchema) Event notification function.
void	notifyUCIControlSchemaUpdate_Event(java.lang.String ctrSchema) Event notification function.
void	notifyUCIDataSchemaUpdate_Event(java.lang.String dataSchema) Event notifier function.
void	notifyUCIFormReceived_Event(java.lang.String formXML) Event notification function.
void	notifyUCIParticipantAdded_Event(java.lang.String personName, java.lang.String personRole, java.lang.String personID) Event notifier function.
void	notifyUnrecognizedEvent()
void	notifyUserAddFileToCommunication_Event(java.lang.String connID, java.lang.String fileName) Event notification function.
void	notifyUserAddFormToCommunication_Event(java.lang.String connID, java.lang.String formName) Event notification function.
void	notifyUserAddParticipantToComm_Event(java.lang.String connID, java.lang.String userName) Event notification function.
void	notifyUserCloseApp_Event(java.lang.String appID) Event notifier function.
void	notifyUserEditPassword_Event() Event notification function.
void	notifyUserEditProfileOpen_Event() Event notification function.
void	notifyUserFormFileOpen_Event(java.lang.String formFileName, java.lang.String formID) Event function notifier function.
void	notifyUserLoginAccepted_Event(java.lang.String username, java.lang.String password) Event Notification function.
void	notifyUserLoginAttempt_Event(java.lang.String username, java.lang.String password) Event notification function.
void	notifyUserLogout_Event() Event notification function.
void	notifyUserNewCallStarted_Event(java.lang.String commID, java.lang.String appName) Event notifier function.
void	notifyUserOpenCall_Event(java.lang.String callFileName) Event function notifier.
void	notifyUserOpenForm_Event(java.lang.String formName) Event notification function this function notifies UIC of a User form open event which is triggered when the user attempts to open a form.
void	notifyUserPasswordChangeAttempt_Event(java.lang.String userName, java.lang.String oldPassword, java.lang.String newPassword, java.lang.String fName, java.lang.String lName, java.lang.String pPic, boolean voiceEnable, java.lang.String role) Event notification function.
void	notifyUserPasswordChanged_Event(java.lang.String userName, java.lang.String newPassword, java.lang.String fName, java.lang.String lName, java.lang.String pPic, boolean voiceEnable, java.lang.String role) Event notification function.
void	notifyUserProfileEdited_Event(java.lang.String userName, java.lang.String password, java.lang.String fName, java.lang.String lName, java.lang.String pPic, boolean voiceEnable, java.lang.String role) Event notification function.
void	notifyUserRemoveParticipantFromComm_Event(java.lang.String connID, java.lang.String userName) Event notification function.
void	notifyUserSaveConn_Event(java.lang.String commID, java.lang.String fileName) Event notification function.
void	notifyUserSaveForm_Event(java.lang.String formName, java.lang.String xmlForm) Event notification function this function notifies UIC of a User form save event which is triggered when the user attempts to save the a form.
void	notifyUserSendChat_Event(java.lang.String connID, java.lang.String userName, java.lang.String message) Event notifier function.
void	notifyUserSendControlSchema_Event(java.lang.String connID) Event notifier function.
void	removeUpListener(Uses_Listener listener) Removes an event from the list

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getInstance

public static UCIEventObjectManager getInstance()

Implementation of the Instance method as in the singleton design pattern.

Returns:

Instance of the UCMEVentObjectManager.

addUpListener

public void addUpListener(Uses_Listener listener)

Adds listener on this object.

Parameters:

listener - listerner to register.

addDownListener

public void addDownListener(java.util.EventListener listener)

Deprecated.

Parameters:

listener - listerner

removeUpListener

public void removeUpListener(Uses_Listener listener)

Removes an event from the list

Parameters:

listener - listener to remove.

notifyUserLoginAttempt_Event

public void notifyUserLoginAttempt_Event(java.lang.String username,
                                         java.lang.String password)

Event notification function. This function will fire the event to notify UCI of an attempt by the user to login.

Parameters:

username -

password -

notifyUserLogout_Event

public void notifyUserLogout_Event()

Event notification function. This function will fire the event to notify UCI of a user logout.

notifyUserLoginAccepted_Event

public void notifyUserLoginAccepted_Event(java.lang.String username,
                                          java.lang.String password)

Event Notification function. This function will fire to notify UCI of a user login accepted event.

Parameters:

username -

password -

notifyGUIExpandView_Event

public void notifyGUIExpandView_Event()

Event notification function. This function is used to notify UCI of a GUI expand view event.

notifyGUIHideView_Event

public void notifyGUIHideView_Event()

Event notification function. This function is used to notify UCI of a GUI hide event.

notifyUserEditProfileOpen_Event

public void notifyUserEditProfileOpen_Event()

Event notification function. This function is used to notify UCI of a User edit profile event. This event is used to signal the user has clicked on the button to allow him/her to edit the profile.

notifyUserEditPassword_Event

public void notifyUserEditPassword_Event()

Event notification function. This function is used to notify UCI of a user password edit event. This event is used to notify UCI that the user desires to open the controls to change his/her password.

notifyUserProfileEdited_Event

public void notifyUserProfileEdited_Event(java.lang.String userName,
                                          java.lang.String password,
                                          java.lang.String fName,
                                          java.lang.String lName,
                                          java.lang.String pPic,
                                          boolean voiceEnable,
                                          java.lang.String role)

Event notification function. This function notifies UCI that the user has edited his/her profile.

notifyUserPasswordChangeAttempt_Event

public void notifyUserPasswordChangeAttempt_Event(java.lang.String userName,
                                                  java.lang.String oldPassword,
                                                  java.lang.String newPassword,
                                                  java.lang.String fName,
                                                  java.lang.String lName,
                                                  java.lang.String pPic,
                                                  boolean voiceEnable,
                                                  java.lang.String role)

Event notification function. This function notifies UCI of the password change attempt by the user.

Parameters:

userName -

oldPassword -

newPassword -

fName -

lName -

pPic -

voiceEnable -

role -

notifyUserPasswordChanged_Event

public void notifyUserPasswordChanged_Event(java.lang.String userName,
                                            java.lang.String newPassword,
                                            java.lang.String fName,
                                            java.lang.String lName,
                                            java.lang.String pPic,
                                            boolean voiceEnable,
                                            java.lang.String role)

Event notification function. This function notifies UCI of a user password change by the user.

Parameters:

userName -

newPassword -

fName -

lName -

pPic -

voiceEnable -

role -

notifyUserNewCallStarted_Event

public void notifyUserNewCallStarted_Event(java.lang.String commID,
                                           java.lang.String appName)

Event notifier function. This function notifies UCI of a New Call Event.

Parameters:

commID -

appName -

notifyGUINewCallStarted_Event

public void notifyGUINewCallStarted_Event(java.lang.String commID,
                                          java.lang.String appName)

Event notifier function. This function notifies UCI of a New Call Event.

Parameters:

commID -

appName -

notifyUserCloseApp_Event

public void notifyUserCloseApp_Event(java.lang.String appID)

Event notifier function. This function notifies UCI of a User close application event.

Parameters:

appID -

notifyGUICloseApp_Event

public void notifyGUICloseApp_Event(java.lang.String appID)

Event notifier function. This function notifies UCI of a GUI close application event. This is triggered by a change in the communication schema that signals the termination of the communication. It closes the tab for that communication.

Parameters:

appID -

notifyGUISidePanelToggle_Event

public void notifyGUISidePanelToggle_Event()

Event notifier function. This function notifies UCI of a GUISidePanelHide_Event

notifyGUICreationFormPanelOpen_Event

public void notifyGUICreationFormPanelOpen_Event()

Event notification function. This function notifies UCI of the GUICreationFormOpen.

notifyGUIFormPanelClose_Event

public void notifyGUIFormPanelClose_Event()

Event notifier function. This function notifies UCI of a GUIFormPanelClose event.

notifyGUIFormPanelClear_Event

public void notifyGUIFormPanelClear_Event()

Event notifier function. The function notifies UCI of GUIFormPanelClear event.

notifyUCIParticipantAdded_Event

public void notifyUCIParticipantAdded_Event(java.lang.String personName,
                                            java.lang.String personRole,
                                            java.lang.String personID)

Event notifier function. This function notifies UCI of a participant added event.

Parameters:

personName -

personRole -

personID -

notifyUCIContactRemoved_Event

public void notifyUCIContactRemoved_Event(java.lang.String userName)

Event notification function. This function notifies UCI of a UCIContactRemoved event.

Parameters:

userName -

notifyGUIAddParticipantToComm_Event

public void notifyGUIAddParticipantToComm_Event(java.lang.String connID,
                                                java.lang.String userName)

Event notification function. This function notifies UCI of a Participant added to Communication event. This event is triggered when there is a change in the communication schema that represents a participant addition. This causes the GUI to reflect the participant addition.

Parameters:

connID -

userName -

notifyUserAddParticipantToComm_Event

public void notifyUserAddParticipantToComm_Event(java.lang.String connID,
                                                 java.lang.String userName)

Event notification function. This function notifies UCI of a Participant added to Communication event, by the user. This triggers a change in the communication schema that adds the participant to the communication.

Parameters:

connID -

userName -

notifyDataSchemaReceived

public void notifyDataSchemaReceived(NegotiationSchema negSchema)

Event notification function. This function notifies UCI of a Data Schema Received.

Parameters:

negSchema -

notifyUCIControlSchemaReceived

public void notifyUCIControlSchemaReceived(java.lang.String ctrSchema)

Event notification function. Used to notify UCI of a control schema received event.

Parameters:

ctrSchema -

notifyUserRemoveParticipantFromComm_Event

public void notifyUserRemoveParticipantFromComm_Event(java.lang.String connID,
                                                      java.lang.String userName)

Event notification function. This function notifies UCI of participant removed. This event occurs when the user adds a person from the GUI. It causes UCI to update its current schema to display the participant removal.

Parameters:

connID -

userName -

notifyGUIRemoveParticipantFromComm_Event

public void notifyGUIRemoveParticipantFromComm_Event(java.lang.String connID,
                                                     java.lang.String userName)

Event notification function. This function notifies UCI of a participant remove event. This even occurs when there has been a change in the GUI that represents a participant removal. This event causes the GUI to reflect the participant removal.

Parameters:

connID -

userName -

notifyUserSaveForm_Event

public void notifyUserSaveForm_Event(java.lang.String formName,
                                     java.lang.String xmlForm)

Event notification function this function notifies UIC of a User form save event which is triggered when the user attempts to save the a form.

Parameters:

formName -

xmlForm -

notifyUserOpenForm_Event

public void notifyUserOpenForm_Event(java.lang.String formName)

Event notification function this function notifies UIC of a User form open event which is triggered when the user attempts to open a form.

Parameters:

formName -

notifyGUIOpenForm_Event

public void notifyGUIOpenForm_Event(java.lang.String formName)

Event notifier function. This function notifies the GUI to open the form window for a given form.

Parameters:

formName -

notifyUserAddFormToCommunication_Event

public void notifyUserAddFormToCommunication_Event(java.lang.String connID,
                                                   java.lang.String formName)

Event notification function. This function notifies the user's drag of a form onto an active communication.

Parameters:

formName -

notifyUserAddFileToCommunication_Event

public void notifyUserAddFileToCommunication_Event(java.lang.String connID,
                                                   java.lang.String fileName)

Event notification function. This function notifies the user's drag of a file onto an active communication.

Parameters:

fileName -

notifyGUIAddFormToCommunication_Event

public void notifyGUIAddFormToCommunication_Event(java.lang.String commID,
                                                  java.lang.String formName)

Event notification function. This function is used to notify the GUI to add a new form to the form list of an active communication.

Parameters:

commID -

formName -

notifyUCIControlSchemaUpdate_Event

public void notifyUCIControlSchemaUpdate_Event(java.lang.String ctrSchema)

Event notification function. This function is used to notify UCI of a control schema change event.

Parameters:

ctrSchema -

notifyUserSaveConn_Event

public void notifyUserSaveConn_Event(java.lang.String commID,
                                     java.lang.String fileName)

Event notification function. This function is used to notify a user's attempt to save a communication schema.

Parameters:

commID -

fileName -

notifyUnrecognizedEvent

public void notifyUnrecognizedEvent()

notifyUserSendControlSchema_Event

public void notifyUserSendControlSchema_Event(java.lang.String connID)

Event notifier function. This function notifies of that the user has pressed the button to send the Control Schema down to SE to start a communication.

Parameters:

connID -

notifyUserSendChat_Event

public void notifyUserSendChat_Event(java.lang.String connID,
                                     java.lang.String userName,
                                     java.lang.String message)

Event notifier function. This function notifies UCI of a user's attempt to send a chat message.

Parameters:

connID -

userName -

message -

notifyGUIShowChat_Event

public void notifyGUIShowChat_Event(java.lang.String connID,
                                    java.lang.String userName,
                                    java.lang.String message)

Event notification function. This function notifies the GUI to display a chat message.

Parameters:

connID -

userName -

message -

notifyUCIDataSchemaUpdate_Event

public void notifyUCIDataSchemaUpdate_Event(java.lang.String dataSchema)

Event notifier function. This function notifies the CUI of a change in the data schema.

Parameters:

dataSchema -

notifyGUIMyFormsPanelRefresh_Event

public void notifyGUIMyFormsPanelRefresh_Event()

Event notifier function. This function is used to notify the GUI to refresh the My Forms panel.

notifyGUIAddFileToCommunication_Event

public void notifyGUIAddFileToCommunication_Event(java.lang.String connID,
                                                  java.lang.String fileName)

Event notifier function. This function notifies UCI to add a file to the GUI.

Parameters:

connID -

fileName -

notifyGUIMyAppPanelRefresh_Event

public void notifyGUIMyAppPanelRefresh_Event()

Event notifier function. This function notifies the GUI to refresh the MyApps Panel

notifyUserOpenCall_Event

public void notifyUserOpenCall_Event(java.lang.String callFileName)

Event function notifier. This function notifies of the user's attempt to open a call schema from the calls panel.

Parameters:

callFileName -

notifyUCIFormReceived_Event

public void notifyUCIFormReceived_Event(java.lang.String formXML)

Event notification function. This function notifies UIC of a form received from SE.

Parameters:

formXML -

notifyUserFormFileOpen_Event

public void notifyUserFormFileOpen_Event(java.lang.String formFileName,
                                         java.lang.String formID)

Event function notifier function. This function notifies the user's attempt to open a file inside a form.

Parameters:

formFileName -

formID -

fireUpEvent

public void fireUpEvent(Handles_Event event)

General Event Trigger. This method will fire the given event.

Parameters:

event - event to signal.