com.plumtree.portalpages.admin.editors.webservice.plugins
Class UserPrefsPluginModel

java.lang.Object
  extended by com.plumtree.uiinfrastructure.editor.EditorHelperModel
      extended by com.plumtree.portalpages.admin.editors.webservice.plugins.UserPrefsPluginModel
All Implemented Interfaces:
IWSSubModel, IUserPrefsPluginModelRO, IManagedObject, IModel, IModelRO, IMVCObject

public class UserPrefsPluginModel
extends EditorHelperModel
implements IUserPrefsPluginModelRO, IWSSubModel

Author:
adolfoc

Field Summary
static java.lang.String STR_MVC_CLASS_NAME
           
static int UPPM_PREFMODE_ADMINPREFS
           
static int UPPM_PREFMODE_COMMUNITYPREFS
           
static int UPPM_PREFMODE_SESSIONPREFS
           
static int UPPM_PREFMODE_USERPREFS
          These values specify whether this model is used to set community preferences or user preferences.
 
Fields inherited from class com.plumtree.uiinfrastructure.editor.EditorHelperModel
m_asOwner
 
Constructor Summary
UserPrefsPluginModel()
           
 
Method Summary
 java.lang.Object Create()
          This method is used by the ASManager to return new instances of managed objects.
 void DoTaskBeforeWSStore()
          Sub models are expected to store themselves to the ptWebService object passed in in InitWSModel during this call.
 void DoTaskOnRemoteServerUpdate(java.lang.String strRemoteServerID, java.lang.String strRemoteServerName, java.lang.String strRemoteServerBaseURL)
          Called when the Remote Server is changed.
 void DoTaskOnWSModeUpdate(int nNewWSMode)
          Called when the Web Service type is changed.
 java.lang.String GetBaseURL()
           
 java.lang.String GetName()
          Returns the Class name.
 int GetPrefMode()
          This method checks whether this model is used to set community preferences or user preferences.
 java.lang.String GetPrefsURL()
          Returns the Admin Prefs URL
 java.lang.String GetTemplatePrefsURL()
           
 java.lang.String GetValidationFunction()
          This returns the name of the client-side validation function that the model wants added to the page-level validation funtion.
 void InitWSModel(IPTWebService ptWebService)
          Initializes the sub-model.
 int SaveSection(XPHashtable _htFormData)
          Code to save the section represented by this Model.
 void SetPrefMode(int nPrefMode)
          This method specifies whether this model is used to set community preferences or user preferences.
 void SetPrefsURL(java.lang.String strPrefsURL)
          Sets the Admin Prefs URL
 void SetTemplatePrefsURL(java.lang.String strPrefsURL)
          Sets the Template Admin Prefs URL
 
Methods inherited from class com.plumtree.uiinfrastructure.editor.EditorHelperModel
CleanupAllData, CleanupTempData, Init
 
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

UPPM_PREFMODE_USERPREFS

public static final int UPPM_PREFMODE_USERPREFS
These values specify whether this model is used to set community preferences or user preferences. The call to SetPrefMode can be used to set this when the model is initialized. GetPrefMode can be used to get which mode this model is in.

See Also:
Constant Field Values

UPPM_PREFMODE_COMMUNITYPREFS

public static final int UPPM_PREFMODE_COMMUNITYPREFS
See Also:
Constant Field Values

UPPM_PREFMODE_ADMINPREFS

public static final int UPPM_PREFMODE_ADMINPREFS
See Also:
Constant Field Values

UPPM_PREFMODE_SESSIONPREFS

public static final int UPPM_PREFMODE_SESSIONPREFS
See Also:
Constant Field Values
Constructor Detail

UserPrefsPluginModel

public UserPrefsPluginModel()
Method Detail

Create

public java.lang.Object Create()
Description copied from class: EditorHelperModel
This method is used by the ASManager to return new instances of managed objects.

Specified by:
Create in interface IManagedObject
Specified by:
Create in class EditorHelperModel
Returns:
A new instance of the managed class (i.e. return new Foo();)
See Also:
IManagedObject.Create()

DoTaskBeforeWSStore

public void DoTaskBeforeWSStore()
Description copied from interface: IWSSubModel
Sub models are expected to store themselves to the ptWebService object passed in in InitWSModel during this call.

Specified by:
DoTaskBeforeWSStore in interface IWSSubModel
See Also:
IWSSubModel.DoTaskBeforeWSStore()

DoTaskOnRemoteServerUpdate

public void DoTaskOnRemoteServerUpdate(java.lang.String strRemoteServerID,
                                       java.lang.String strRemoteServerName,
                                       java.lang.String strRemoteServerBaseURL)
Description copied from interface: IWSSubModel
Called when the Remote Server is changed. This is mostly used to update the base-url displayed before URL edit boxes.

Specified by:
DoTaskOnRemoteServerUpdate in interface IWSSubModel
See Also:
IWSSubModel.DoTaskOnRemoteServerUpdate(String, String, String)

DoTaskOnWSModeUpdate

public void DoTaskOnWSModeUpdate(int nNewWSMode)
Description copied from interface: IWSSubModel
Called when the Web Service type is changed.

Specified by:
DoTaskOnWSModeUpdate in interface IWSSubModel
See Also:
IWSSubModel.DoTaskOnWSModeUpdate(int)

GetBaseURL

public java.lang.String GetBaseURL()
Specified by:
GetBaseURL in interface IUserPrefsPluginModelRO
Returns:
See Also:
com.plumtree.portalpages.admin.editors.webservice.plugins.IAdminPrefsPluginModelRO#GetBaseURL()

GetName

public java.lang.String GetName()
Description copied from class: EditorHelperModel
Returns the Class name.

Specified by:
GetName in interface IMVCObject
Specified by:
GetName in class EditorHelperModel
Returns:
String
See Also:
IMVCObject.GetName()

GetPrefMode

public int GetPrefMode()
This method checks whether this model is used to set community preferences or user preferences. SetPrefMode can be used to set this when the model is initialized. GetPrefMode can be used to get which mode this model is in.

Specified by:
GetPrefMode in interface IUserPrefsPluginModelRO
Returns:

GetPrefsURL

public java.lang.String GetPrefsURL()
Returns the Admin Prefs URL

Specified by:
GetPrefsURL in interface IUserPrefsPluginModelRO
Returns:
String

GetTemplatePrefsURL

public java.lang.String GetTemplatePrefsURL()
Specified by:
GetTemplatePrefsURL in interface IUserPrefsPluginModelRO
Returns:
See Also:
IUserPrefsPluginModelRO.GetTemplatePrefsURL()

GetValidationFunction

public java.lang.String GetValidationFunction()
Description copied from interface: IWSSubModel
This returns the name of the client-side validation function that the model wants added to the page-level validation funtion. Models return null or "" if they don't have a validation function.

Specified by:
GetValidationFunction in interface IWSSubModel
See Also:
IWSSubModel.GetValidationFunction()

InitWSModel

public void InitWSModel(IPTWebService ptWebService)
Description copied from interface: IWSSubModel
Initializes the sub-model. Provides an opportunity for the submodel to load it's state from the WebService.

Specified by:
InitWSModel in interface IWSSubModel
See Also:
com.plumtree.portalpages.admin.editors.webservice.IWSSubModel#InitWSModel()

SaveSection

public int SaveSection(XPHashtable _htFormData)
Description copied from class: EditorHelperModel
Code to save the section represented by this Model.

Specified by:
SaveSection in class EditorHelperModel
Parameters:
_htFormData - Form posted data.
Returns:
int Status for server side validation
See Also:
EditorHelperModel.SaveSection(XPHashtable)

SetPrefMode

public void SetPrefMode(int nPrefMode)
This method specifies whether this model is used to set community preferences or user preferences. SetPrefMode can be used to set this when the model is initialized. GetPrefMode can be used to get which mode this model is in.


SetPrefsURL

public void SetPrefsURL(java.lang.String strPrefsURL)
Sets the Admin Prefs URL

Parameters:
strAdminPrefsURL - The Admin Prefs URL to set

SetTemplatePrefsURL

public void SetTemplatePrefsURL(java.lang.String strPrefsURL)
Sets the Template Admin Prefs URL

Parameters:
strAdminPrefsURL - The Admin Prefs URL to set



Copyright © 2002,2003,2004,2005 Plumtree Software, Inc., All Rights Reserved.