com.ibm.tivoli.imi.controller

Class ChatHelper

java.lang.Object

com.ibm.tivoli.imi.controller.ChatHelper

All Implemented Interfaces:

IMMessageListener

public class ChatHelper
extends java.lang.Object
implements IMMessageListener

Method Summary

Modifier and Type	Method and Description
boolean	abortConversation(boolean saveFlag, javax.servlet.http.HttpServletRequest request)
boolean	abortConversation(boolean saveFlag, WebClientSession webClientSession) This method is called every time the IM session is closed while this chat session is still opened.
boolean	closeConversation(javax.servlet.http.HttpServletRequest request)
boolean	closeConversation(WebClientSession webClientSession) This method is called every time the user (analyst) closes his/her chat window.
void	conversationClosed(java.lang.String reason) This method is called every time the partner (customer) closes his/her chat window.
boolean	isNewChatHelper()
boolean	isNewRecord()
boolean	isOpened()
void	messageReceived(IMMessageEvent messageEvent) Handles incoming response messages from partner
java.lang.String	popMessageBuffer() Get the current message buffer, and clear it out
void	sendMessage(java.lang.String message) Send a message to target partner
void	validate(long chatIdentifier)

Methods inherited from class java.lang.Object

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

Method Detail

validate

public void validate(long chatIdentifier)
              throws TsdIMException

Throws:

TsdIMException

isNewChatHelper

public boolean isNewChatHelper()

isNewRecord

public boolean isNewRecord()
                    throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

sendMessage

public void sendMessage(java.lang.String message)
                 throws IMException

Send a message to target partner

Throws:

IMException

popMessageBuffer

public java.lang.String popMessageBuffer()

Get the current message buffer, and clear it out

messageReceived

public void messageReceived(IMMessageEvent messageEvent)

Handles incoming response messages from partner

Specified by:

messageReceived in interface IMMessageListener

conversationClosed

public void conversationClosed(java.lang.String reason)

This method is called every time the partner (customer) closes his/her chat window. It will not close the conversation, but only append a message in the chat history saying that the customer has closed his/her chat window

Specified by:

conversationClosed in interface IMMessageListener

closeConversation

public boolean closeConversation(WebClientSession webClientSession)
                          throws java.lang.Exception

This method is called every time the user (analyst) closes his/her chat window. It will close the conversation and request the chat transcript to be generated and saved in Communication Log

Returns:

true only if the chat transcript could be saved

Throws:

java.lang.Exception

closeConversation

public boolean closeConversation(javax.servlet.http.HttpServletRequest request)
                          throws java.lang.Exception

Throws:

java.lang.Exception

abortConversation

public boolean abortConversation(boolean saveFlag,
                                 WebClientSession webClientSession)
                          throws java.lang.Exception

This method is called every time the IM session is closed while this chat session is still opened. In this situation a new message registering this event is appended in chat history and this chat session is closed immediately (aborted). In this situation the chat transcript can not be saved because the HttpSession and/or the Maximo WebClientSession does not exist anymore

Returns:

true only if the chat transcript could be saved

Throws:

java.lang.Exception

abortConversation

public boolean abortConversation(boolean saveFlag,
                                 javax.servlet.http.HttpServletRequest request)
                          throws java.lang.Exception

Throws:

java.lang.Exception

isOpened

public boolean isOpened()