com.plumtree.uiinfrastructure.editor
Class EditorHelperModel

java.lang.Object
  com.plumtree.uiinfrastructure.editor.EditorHelperModel

All Implemented Interfaces:

IManagedObject, IModel, IModelRO, IMVCObject

Direct Known Subclasses:

AddSettingsPluginModel, AdvSettingsPluginModel, AssocObjectsPluginModel, AuthSourceSelectWebServiceModel, AWSSettingsPluginModel, BasicAuthPluginModel, CardLanguagePlugInModel, ChooseWSTypePluginModel, CredentialVaultPluginModel, CWSSettingsPluginModel, DataSourceSelectWebServiceModel, DebugConfigPluginModel, DebugPortletPluginModel, DebugUserPluginModel, DocTypePlugInModel, ExpListModel, FolderSelectorModel, FormLoginPluginModel, GatewayCachingPluginModel, GatewaySettingsPluginModel, HelpURLPluginModel, HTTPSettingsPluginModel, IntrinsicHelpSpacePluginModel, IntrinsicPortletWSSettingsPluginModel, IntrinsicProfilePluginModel, IntrinsicUserPrefsPluginModel, LinkSettingsPlugInModel, MigrationHistoryPluginModel, MWSSettingsPluginModel, OutgoingNSSelectWebServiceModel, PageLayoutPlugInModel, PageNamePlugInModel, PasswordManagerSectionModel, PChooseModel, PortletSettingsModel, PriorityDropDownModel, ProfileSourceSelectWebServiceModel, PSelectTemplateModel, PWSSettingsPluginModel, RemoteConfigPluginModel, RemoteMigrationPluginModel, RemoteServerPluginModel, SelectDevicesPluginModel, SelectWebServiceModel, SetJobModel, SimpleSelectorModel, SiteMapFolderPlugInModel, SOAPEncodingPluginModel, SummaryURLPluginModel, SWSSettingsPluginModel, TypeSelectorModel, UserInfoPluginModel, UserPrefsPluginModel, XUIHelperModel, XUIURLPluginModel

public abstract class EditorHelperModel
extends java.lang.Object
implements IModel

This class is a helper class for the EditorModel. This is NOT a real EditorModel or RepostModel. The saveSection method will have to be called by the main EditorModel class of the Editor. This class can be used to implement common or plug-in sections and can also be used as a secondary Model class if the main one is getting too big and you want to split the code into multiple classes.

Author:

Julie Fournier

Field Summary

AActivitySpace

m_asOwner Associated Activity Space.

Constructor Summary

EditorHelperModel()

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.
abstract java.lang.Object	Create() This method is used by the ASManager to return new instances of managed objects.
abstract java.lang.String	GetName() Returns the Class name.
void	Init(AActivitySpace parent) Inits the Model with the Activity Space.
abstract int	SaveSection(XPHashtable _htFormData) Code to save the section represented by this Model.

Methods inherited from class java.lang.Object

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

Field Detail

m_asOwner

public AActivitySpace m_asOwner

Associated Activity Space.

Constructor Detail

EditorHelperModel

public EditorHelperModel()

Method Detail

Create

public abstract java.lang.Object Create()

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 abstract java.lang.String GetName()

Returns the Class name.

Specified by:

GetName in interface IMVCObject

Returns:

String

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

Init

public void Init(AActivitySpace parent)

Inits the Model with the Activity Space.

Specified by:

Init in interface IModel

Parameters:

parent -

SaveSection

public abstract int SaveSection(XPHashtable _htFormData)

Code to save the section represented by this Model.

Parameters:

_htFormData - Form posted data.

Returns:

int Status for server side validation