com.plumtree.portalpages.browsing.search.results
Class LoggingHelperModel

java.lang.Object
  com.plumtree.portalpages.browsing.search.results.LoggingHelperModel

All Implemented Interfaces:

IManagedObject, IModel, IModelRO, IMVCObject

public class LoggingHelperModel
extends java.lang.Object
implements IModel

Field Summary

protected java.lang.String	_queryLoggingId Query logging id, set to non-null when this is a banner search (in ).
static java.lang.String	SEARCH_TYPE_ADVANCED Search type - Advanced search
static java.lang.String	SEARCH_TYPE_BANNER Search type - Banner search
static java.lang.String	STR_MVC_CLASS_NAME Name of this class

Constructor Summary

LoggingHelperModel()

Method Summary

void	CleanupAllData() This method is called when an ActivitySpace is removed from the cache.
void	CleanupTempData() This method is called at the end of every HTTP request by the Interpreter.
java.lang.Object	Create() This method is used by the ASManager to return new instances of managed objects.
java.lang.String	GetLoggingID()
java.lang.String	GetName() Return the name of the MVC object.
void	Init(AActivitySpace parent) This method initializes the model.
void	LogSearchResultsEvent(int nNumTotalMatches, int nResultStartRange, int nResultEndRange, java.lang.String drilldownKey)
void	LogStartSearchEvent(java.lang.String searchString, java.lang.String searchType)

Methods inherited from class java.lang.Object

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

Field Detail

STR_MVC_CLASS_NAME

public static final java.lang.String STR_MVC_CLASS_NAME

Name of this class

See Also:

Constant Field Values

SEARCH_TYPE_BANNER

public static final java.lang.String SEARCH_TYPE_BANNER

Search type - Banner search

See Also:

Constant Field Values

SEARCH_TYPE_ADVANCED

public static final java.lang.String SEARCH_TYPE_ADVANCED

Search type - Advanced search

See Also:

Constant Field Values

_queryLoggingId

protected java.lang.String _queryLoggingId

Query logging id, set to non-null when this is a banner search (in ).

Constructor Detail

LoggingHelperModel

public LoggingHelperModel()

Method Detail

Init

public void Init(AActivitySpace parent)

Description copied from interface: IModel

This method initializes the model. This is called automatically when AActivitySpace.RegisterModel() is called.

Specified by:

Init in interface IModel

Parameters:

parent - the parent Activity Space

CleanupTempData

public void CleanupTempData()

Description copied from interface: IModel

This method is called at the end of every HTTP request by the Interpreter. The Interpreter calls AActivitySpace.CleanupTempData(), which calls this method on all IModels registered using AActivitySpace.RegisterModel(). This method is intended for cleaning up temporary data that is only used for the lifetime of a single request, like DB query results.

Specified by:

CleanupTempData in interface IModel

CleanupAllData

public void CleanupAllData()

Description copied from interface: IModel

This method is called when an ActivitySpace is removed from the cache. The Interpreter calls AActivitySpace.CleanupAllData(), which calls this method on all IModels registered using AActivitySpace.RegisterModel(). This method is intended for releasing data stored in the server when the activity space is no longer needed, such as search objects that need to be maintained as long as the user is clicking through the search, but should be freed when the space can no longer be used. This can be used to prevent Java references to COM memory from hanging around in the long lived Java heap without cleaning up the underlying COM memory. The Java reference will still stay in the long lived heap until it gets garbage collected (which could be a while), but the COM memory should get released here. This method will not be called if an HTTPSession times out. CleanupTempData will be called before CleanupAllData.

Specified by:

CleanupAllData in interface IModel

Create

public java.lang.Object Create()

Description copied from interface: IManagedObject

This method is used by the ASManager to return new instances of managed objects.

Specified by:

Create in interface IManagedObject

Returns:

A new instance of the managed class (i.e. return new Foo();)

GetName

public java.lang.String GetName()

Description copied from interface: IMVCObject

Return the name of the MVC object.

Specified by:

GetName in interface IMVCObject

Returns:

the name of the object.

GetLoggingID

public java.lang.String GetLoggingID()

LogStartSearchEvent

public void LogStartSearchEvent(java.lang.String searchString,
                                java.lang.String searchType)

LogSearchResultsEvent

public void LogSearchResultsEvent(int nNumTotalMatches,
                                  int nResultStartRange,
                                  int nResultEndRange,
                                  java.lang.String drilldownKey)