com.plumtree.uiinfrastructure.tips
Class TipsModel

java.lang.Object
  com.plumtree.uiinfrastructure.tips.TipsModel

All Implemented Interfaces:

IManagedObject, IModel, IModelRO, IMVCObject, ITipsModelRO

Direct Known Subclasses:

PortalTipsModel

public class TipsModel
extends java.lang.Object
implements IModel, ITipsModelRO

This is an abstract model extended by various concrete error model.

Author:

Beng

Field Summary

protected AActivitySpace	m_asOwner
static java.lang.String	STR_508_HELP_DIR
static java.lang.String	STR_MVC_CLASS_NAME
static java.lang.String	STR_STANDARD_HELP_DIR

Constructor Summary

TipsModel()

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.
void	DisableTips()
HTMLElement	GetDefaultTip()
java.lang.String	GetDefaultTipTitle()
boolean	GetDisplayGeneratingClass()
boolean	GetDoDisplayTipsBox()
java.lang.String	GetGeneratingClass()
java.lang.String	GetName() Return the name of the MVC object.
HTMLElement	GetSecondaryTip()
java.lang.String	GetSecondaryTipTitle()
HTMLElement	GetTip()
java.lang.String	GetTipTitle()
void	Init(AActivitySpace parent) Inits the Model with the Activity Space.
void	SetDefaultTip(HTMLElement e)
void	SetDefaultTipTitle(java.lang.String s)
void	SetDisplayGeneratingClass(boolean b)
void	SetDoDisplayTipsBox(boolean b)
void	SetGeneratingClass(java.lang.String s)
void	SetSecondarTip(HTMLElement e)
void	SetSecondarTipTitle(java.lang.String s)
void	SetTip(HTMLElement e)
void	SetTipTitle(java.lang.String s)

Methods inherited from class java.lang.Object

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

Field Detail

STR_508_HELP_DIR

public static final java.lang.String STR_508_HELP_DIR

See Also:

Constant Field Values

STR_STANDARD_HELP_DIR

public static final java.lang.String STR_STANDARD_HELP_DIR

See Also:

Constant Field Values

STR_MVC_CLASS_NAME

public static final java.lang.String STR_MVC_CLASS_NAME

See Also:

Constant Field Values

m_asOwner

protected AActivitySpace m_asOwner

Constructor Detail

TipsModel

public TipsModel()

Method Detail

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

See Also:

IModel.CleanupTempData()

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

See Also:

IModel.CleanupAllData()

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();)

See Also:

IManagedObject.Create()

GetDefaultTip

public HTMLElement GetDefaultTip()

Specified by:

GetDefaultTip in interface ITipsModelRO

Returns:

GetDefaultTipTitle

public java.lang.String GetDefaultTipTitle()

Specified by:

GetDefaultTipTitle in interface ITipsModelRO

Returns:

GetDoDisplayTipsBox

public boolean GetDoDisplayTipsBox()

Specified by:

GetDoDisplayTipsBox in interface ITipsModelRO

Returns:

SetGeneratingClass

public void SetGeneratingClass(java.lang.String s)

GetGeneratingClass

public java.lang.String GetGeneratingClass()

Specified by:

GetGeneratingClass in interface ITipsModelRO

GetDisplayGeneratingClass

public boolean GetDisplayGeneratingClass()

Specified by:

GetDisplayGeneratingClass in interface ITipsModelRO

SetDisplayGeneratingClass

public void SetDisplayGeneratingClass(boolean b)

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.

See Also:

com.plumtree.xpshared.activityspace.IModel#GetName()

GetSecondaryTip

public HTMLElement GetSecondaryTip()

Specified by:

GetSecondaryTip in interface ITipsModelRO

Returns:

GetSecondaryTipTitle

public java.lang.String GetSecondaryTipTitle()

Specified by:

GetSecondaryTipTitle in interface ITipsModelRO

Returns:

GetTip

public HTMLElement GetTip()

Specified by:

GetTip in interface ITipsModelRO

Returns:

GetTipTitle

public java.lang.String GetTipTitle()

Specified by:

GetTipTitle in interface ITipsModelRO

Returns:

Init

public void Init(AActivitySpace parent)

Inits the Model with the Activity Space.

Specified by:

Init in interface IModel

Parameters:

parent -

SetDefaultTip

public void SetDefaultTip(HTMLElement e)

Parameters:

e -

SetDefaultTipTitle

public void SetDefaultTipTitle(java.lang.String s)

Parameters:

s -

SetDoDisplayTipsBox

public void SetDoDisplayTipsBox(boolean b)

Parameters:

b -

SetSecondarTip

public void SetSecondarTip(HTMLElement e)

Parameters:

e -

SetSecondarTipTitle

public void SetSecondarTipTitle(java.lang.String s)

Parameters:

s -

SetTip

public void SetTip(HTMLElement e)

Parameters:

e -

SetTipTitle

public void SetTipTitle(java.lang.String s)

Parameters:

s -

DisableTips

public void DisableTips()