com.plumtree.portalpages.admin.ptutilities
Class PlumtreeUtilitiesModel

java.lang.Object
  com.plumtree.portalpages.admin.ptutilities.PlumtreeUtilitiesModel

All Implemented Interfaces:

IPlumtreeUtilitiesModel, IPlumtreeUtilitiesModelRO, IManagedObject, IModel, IModelRO, IMVCObject

public class PlumtreeUtilitiesModel
extends java.lang.Object
implements IPlumtreeUtilitiesModel, IPlumtreeUtilitiesModelRO

Author:

SudhaS

Field Summary

static java.lang.String

STR_MVC_CLASS_NAME

Constructor Summary

PlumtreeUtilitiesModel()

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.
int	GetActivityRightRestriction(int _nIndex)
java.lang.String	GetName() Return the name of the MVC object.
int	GetNumSettingItems()
java.lang.String	GetSettingItemName(int _nIndex)
java.lang.String	GetSettingItemURL(int _nIndex)
void	Init(AActivitySpace _asOwner) This method initializes the model.
boolean	IsPluggableAdmin(int _nIndex)

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

See Also:

Constant Field Values

Constructor Detail

PlumtreeUtilitiesModel

public PlumtreeUtilitiesModel()

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

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.portaluiinfrastructure.activityspace.IModelRO#GetName()

GetNumSettingItems

public int GetNumSettingItems()

Specified by:

GetNumSettingItems in interface IPlumtreeUtilitiesModel

Specified by:

GetNumSettingItems in interface IPlumtreeUtilitiesModelRO

Returns:

See Also:

com.plumtree.portalpagessample.PlumtreeUtilities.IPlumtreeUtilitiesModelRO#getString()

GetSettingItemName

public java.lang.String GetSettingItemName(int _nIndex)

Specified by:

GetSettingItemName in interface IPlumtreeUtilitiesModel

Specified by:

GetSettingItemName in interface IPlumtreeUtilitiesModelRO

Parameters:

_nIndex -

Returns:

GetSettingItemURL

public java.lang.String GetSettingItemURL(int _nIndex)

Specified by:

GetSettingItemURL in interface IPlumtreeUtilitiesModel

Specified by:

GetSettingItemURL in interface IPlumtreeUtilitiesModelRO

Parameters:

_nIndex -

Returns:

GetActivityRightRestriction

public int GetActivityRightRestriction(int _nIndex)

Specified by:

GetActivityRightRestriction in interface IPlumtreeUtilitiesModelRO

Returns:

activity right associated with this utility; returns PT_ACTIVITY_RIGHTS.PT_ACTIVITY_RIGHT_NONE if there is no activity right associated

IsPluggableAdmin

public boolean IsPluggableAdmin(int _nIndex)

Specified by:

IsPluggableAdmin in interface IPlumtreeUtilitiesModelRO

Returns:

true if this utility is a pluggable admin page; false if it is not

Init

public void Init(AActivitySpace _asOwner)

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:

_asOwner - the parent Activity Space

See Also:

com.plumtree.portaluiinfrastructure.activityspace.IModel#Init(IActivitySpace)