Field Detail

• COPYRIGHT

  public static final java.lang.String COPYRIGHT
  

  IBM copyright notice field

  See Also:

  Constant Field Values

Constructor Detail

• TsConversation

  public TsConversation()
  

  Default constructor for TsConversation.

  The TsConversation object contains all aspects of the conversations between the client and the Web services to which it communicates.

Method Detail

• setupActivityDataNVPs

  public com.ibm.commerce.telesales.services.ws.ActivityDataNameValuePairs setupActivityDataNVPs(ServiceContext sC)
  

  Creates and populates data for starting conversation with the server. There are several values in the server contexts which can be set. If these values are set by this method, they are then passed to the service when the conversation is started.

  The GlobalizationContext values used will be the same as the ones set up for the CSR. This is since the user interface is being viewed by the CSR and not by the customer. (For example values such as language, locale, and currency). These values are set into the ServiceContext by the core plugin prior to this invocation. However, the BaseContext values can, and usually will, be different.

  Parameters:

  sC - the ServiceContext object associated with this request

  Returns:

  context values for start of conversation with server

• setResponseTimeout

  public void setResponseTimeout(java.lang.String timeout)
  

  Method to set the response time out.

  Parameters:

  timeout - response timeout value.

• startConversation

  public com.ibm.commerce.telesales.services.ws.ActivityToken startConversation(ServiceContext serviceContext,
                                                                       java.lang.String hostname,
                                                                       java.lang.String portnumber,
                                                                       boolean fSSLEnabled)
                                                                         throws TelesalesServicesException
  

  Starts the CSR conversation with server, getting activity or conversation token back from the Web service.

  Parameters:

  serviceContext - the ServiceContext object for this request

  hostname - the host name to which to connect

  portnumber - the port number on the host

  fSSLEnabled - to indicate id SSL is enabled

  Returns:

  a non-null valued token to be used on all subsequent communications with server if successful; null if unsuccessful or com.ibm.commerce.component.exception.ServiceException is thrown

  Throws:

  TelesalesServicesException

• startConversation

  public com.ibm.commerce.telesales.services.ws.ActivityToken startConversation(ServiceContext serviceContext,
                                                                       com.ibm.commerce.telesales.services.ws.ActivityToken tsrToken)
                                                                         throws TelesalesServicesException
  

  Starts the customer conversation with server, getting an activity token back from server. This method is used for establishing a conversation with the server for a specific user associated with a specific CSR and store.

  Parameters:

  serviceContext - the ServiceContext object for the service

  tsrToken - the CSR's activity token, used to clone() the customer's conversation

  Returns:

  a non-null valued token to be used on all subsequent communications with server if successful; null if unsuccessful or com.ibm.commerce.component.exception.ServiceException is thrown

  Throws:

  TelesalesServicesException

• stopConversation

  public void stopConversation(java.util.Hashtable tokenTable)
  

  Stops the conversation for a specified customer. The conversation with the Web service is stopped. If a stopConversation() is issued for a CSR, then all the customer conversations associated with that CSR are also stopped.

  Parameters:

  tokenTable - Hashtable of tokens associated with the conversations to stop

• modifyEndpoint

  public java.lang.String modifyEndpoint(java.lang.String endpoint,
                                java.lang.String hostname,
                                java.lang.String portnumber,
                                boolean fSSLenabled)
  

  Modifies a service endpoint to the appropriate hostname-portnumber values. This method is called prior to saving the Service object in the "services mapping table".

  Parameters:

  endpoint - the endpoint to be modified

  hostname - the host name of the endpoint

  portnumber - the port number of the endpoint

  fSSLenabled - to indicate id SSL is enabled

  Returns:

  the newly modified endpoint