atg.projects.b2cstore

Class SearchEventSender

java.lang.Object

atg.projects.b2cstore.SearchEventSender

All Implemented Interfaces:

MessageSource

public class SearchEventSender
extends java.lang.Object
implements MessageSource

This component sends an atg.projects.b2cstore.search message when its fireSearchEvent() method is called. It is used by the /atg/commerce/catalog/CatalogSearch component to record user searches in the bikestore.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASS_VERSION Class version string

Constructor Summary

Constructors

Constructor and Description
SearchEventSender() Constructs an instanceof SearchFormHandler

Method Summary

Modifier and Type	Method and Description
boolean	fireSearchEvent(java.lang.String searchString) Invoke the parent handleSearch, then fire a message to the scenario manager informing it of this most recent search.
MessageSourceContext	getMessageSourceContext()
void	setMessageSourceContext(MessageSourceContext pContext) This notifies the MessageSource as to what its MessageSourceContext should be.
void	startMessageSource() This is called to tell the MessageSource that it may begin sending messages.
void	stopMessageSource() This is called to tell the MessageSource that it should stop sending messages.

Methods inherited from class java.lang.Object

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

Field Detail

CLASS_VERSION

public static java.lang.String CLASS_VERSION

Class version string

Constructor Detail

SearchEventSender

public SearchEventSender()

Constructs an instanceof SearchFormHandler

Method Detail

setMessageSourceContext

public void setMessageSourceContext(MessageSourceContext pContext)

Description copied from interface: MessageSource

This notifies the MessageSource as to what its MessageSourceContext should be. The context is what the component should use to generate and send out Messages. The component should not actually start to send out Messages until startMessageSource() is called. An implementation will generally store the MessageSourceContext in a member variable.

Specified by:

setMessageSourceContext in interface MessageSource

getMessageSourceContext

public MessageSourceContext getMessageSourceContext()

startMessageSource

public void startMessageSource()

Description copied from interface: MessageSource

This is called to tell the MessageSource that it may begin sending messages.

Specified by:

startMessageSource in interface MessageSource

stopMessageSource

public void stopMessageSource()

Description copied from interface: MessageSource

This is called to tell the MessageSource that it should stop sending messages.

Specified by:

stopMessageSource in interface MessageSource

fireSearchEvent

public boolean fireSearchEvent(java.lang.String searchString)

Invoke the parent handleSearch, then fire a message to the scenario manager informing it of this most recent search.

Parameters:

pRequest - the servlet's request

pResponse - the servlet's response

Throws:

ServletException - if there was an error while executing the code

IOException - if there was an error with servlet io