com.plumtree.portalpages.portlets.userprofile.eoddisplay.prefs
Class EODPortletPrefsModel

java.lang.Object
  com.plumtree.uiinfrastructure.editor.EditorModel
      com.plumtree.portaluiinfrastructure.intrinsicportlets.prefs.IntrinsicPortletPrefsEditorModel
          com.plumtree.portalpages.portlets.userprofile.eoddisplay.prefs.EODPortletPrefsModel

All Implemented Interfaces:

IEODPortletPrefsModelRO, IDescriptionModelRO, IIntrinsicPortletPrefsModelRO, IManagedObject, IModel, IModelRO, IMVCObject, IEditorModelRO, IRepostModel

public class EODPortletPrefsModel
extends IntrinsicPortletPrefsEditorModel
implements IEODPortletPrefsModelRO, IDescriptionModelRO

Author:

JHQ, jennifersu

Field Summary

static java.lang.String	SETTING_PROFILEPAGEID
static java.lang.String	STR_MVC_CLASS_NAME object name

Fields inherited from class com.plumtree.portaluiinfrastructure.intrinsicportlets.prefs.IntrinsicPortletPrefsEditorModel

m_bIsAdminPref, m_nCommunityID, m_nPageID, m_nPortletID, m_nPrefType, m_ptPortlet, m_ptSession, m_strPreviousURL, PREF_TYPE_ADMIN, PREF_TYPE_COMMUNITY, PREF_TYPE_PERSONAL, SETTINGSTYPE_ADMIN, SETTINGSTYPE_COMMUNITY, SETTINGSTYPE_COMMUNITYPORTLET, SETTINGSTYPE_PORTLET, SETTINGSTYPE_USER

Fields inherited from class com.plumtree.uiinfrastructure.editor.EditorModel

isReadAccessAvailable, m_asOwner, m_bCloseOnDone, m_bDeleteOnCancel, m_bEnableApplyButton, m_bEnableCancelButton, m_bHideLeftNav, m_bIsEditorReadOnly, m_bUserHasAccessToEditor, m_nEditorType

Constructor Summary

EODPortletPrefsModel()
Creates a new EODPortletPrefsModel object.

Method Summary

int	ActionOnRepost_NewCtg(XPHashtable _htFormData) called by the repost control to create a new category.
void	ActionOnRepost_RenameCtg(XPHashtable _htFormData) called by repost control to rename a category.
void	ActionOnRepost_RenameObjDone(XPHashtable _htFormData) called by repost control when the renaming of an object is complete.
void	Cancel() Implement some code to execute when the user clicks on "Cancel".
protected boolean	CheckActivityRight() Helper method to determine activity rights.
java.lang.Object	Create() This method is used by the ASManager to return new instances of managed objects.
void	DoTaskOnStartEditor(XPHashtable _htFormData) Initializes the property type member variable with the one from IPTProperty in Edit mode and the default value in create mode.
void	Finish() Code executed in finish.
java.lang.String	GetName() Returns the Class name.
int	GetPortletID()
IPTProfilePage	GetProfilePage() returns the Layout object that represents the current user profile layout
int	GetProfilePageID() Sets a new value for the member variable "LayoutID".
static java.lang.String	GetProfileSectionKey(int _intSectionID) helper method that returns the key of a profile section object used to identify profile section objects on the profile page editor ui.
void	Init(AActivitySpace parent) Inits the Model with the IPTSession.
boolean	IsDescriptionDisabled() Returns true if the object description cannot be set/changed from the Editor.
int	SavePage(java.lang.String _sPageName, XPHashtable _htFormData) Calls the right save function according to the page name passed in argument.
protected void	StoreObject(IPTObject _object, java.lang.String _key) Helper method to Store the Object.

Methods inherited from class com.plumtree.portaluiinfrastructure.intrinsicportlets.prefs.IntrinsicPortletPrefsEditorModel

CheckEditorAccessAndStart, GetCommunityId, GetEditorType, GetEnableApplyButton, GetHideLeftNav, GetIsEditorReadOnly, GetPortletFromSpace, GetPortletName, GetPrefType, GetRedirectAfterFinish, GetSettingValue, GetSettingValues, InitializePortlet, RemoveSettingValue, SetEnableApplyButton, SetMemberVariablesFromQS, SetSettingValue

Methods inherited from class com.plumtree.uiinfrastructure.editor.EditorModel

CleanupAllData, CleanupTempData, DoTaskAfterStore, DoTaskBeforeStore, DoTaskOnChangePage, DoTaskOnComeBackFromSubEditor, GetAccessToEditorPriviledges, GetCloseOnDone, GetCurrentRepostAction, GetDeleteOnCancel, GetEnableCancelButton, GetUserHasAccessToEditor, SetCloseOnDone, SetDeleteOnCancel, SetEditorType, SetHideLeftNav, SetPageStatus, SetUserHasAccessToEditor

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.plumtree.portaluiinfrastructure.intrinsicportlets.prefs.IIntrinsicPortletPrefsModelRO

GetCommunityId, GetPortletName, GetPrefType

Methods inherited from interface com.plumtree.uiinfrastructure.editor.IEditorModelRO

GetEditorType, GetEnableApplyButton, GetEnableCancelButton, GetHideLeftNav, GetIsEditorReadOnly

Field Detail

STR_MVC_CLASS_NAME

public static final java.lang.String STR_MVC_CLASS_NAME

object name

See Also:

Constant Field Values

SETTING_PROFILEPAGEID

public static final java.lang.String SETTING_PROFILEPAGEID

See Also:

Constant Field Values

Constructor Detail

EODPortletPrefsModel

public EODPortletPrefsModel()

Creates a new EODPortletPrefsModel object.

Method Detail

GetProfileSectionKey

public static java.lang.String GetProfileSectionKey(int _intSectionID)

helper method that returns the key of a profile section object used to identify profile section objects on the profile page editor ui.

Parameters:

_section - the section in question.

Returns:

String id of section object.

ActionOnRepost_NewCtg

public int ActionOnRepost_NewCtg(XPHashtable _htFormData)

called by the repost control to create a new category.

Parameters:

_htFormData - hashtable with form data including the new name and description of the category to be created.

Returns:

int whether successful or not.

ActionOnRepost_RenameCtg

public void ActionOnRepost_RenameCtg(XPHashtable _htFormData)

called by repost control to rename a category.

Parameters:

_htFormData - posted form data that contains page and section keys to identify the section to be renamed.

ActionOnRepost_RenameObjDone

public void ActionOnRepost_RenameObjDone(XPHashtable _htFormData)

called by repost control when the renaming of an object is complete.

Parameters:

_htFormData - posted form data that identifies ojbect to be renamed

Cancel

public void Cancel()

Description copied from class: EditorModel

Implement some code to execute when the user clicks on "Cancel".

Overrides:

Cancel in class EditorModel

See Also:

EditorModel.Cancel()

DoTaskOnStartEditor

public void DoTaskOnStartEditor(XPHashtable _htFormData)

Initializes the property type member variable with the one from IPTProperty in Edit mode and the default value in create mode.

Overrides:

DoTaskOnStartEditor in class EditorModel

Parameters:

_htFormData -

GetProfilePageID

public int GetProfilePageID()

Sets a new value for the member variable "LayoutID".

Specified by:

GetProfilePageID in interface IEODPortletPrefsModelRO

Returns:

Create

public java.lang.Object Create()

Description copied from class: EditorModel

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 EditorModel

Returns:

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

See Also:

IManagedObject.Create()

Finish

public void Finish()

Code executed in finish.

Specified by:

Finish in interface IRepostModel

Specified by:

Finish in class EditorModel

GetName

public java.lang.String GetName()

Returns the Class name.

Specified by:

GetName in interface IMVCObject

Specified by:

GetName in class EditorModel

Returns:

String

Init

public void Init(AActivitySpace parent)

Description copied from class: IntrinsicPortletPrefsEditorModel

Inits the Model with the IPTSession.

Specified by:

Init in interface IModel

Overrides:

Init in class IntrinsicPortletPrefsEditorModel

Parameters:

parent - the parent Activity Space

See Also:

IModel.Init(AActivitySpace)

IsDescriptionDisabled

public boolean IsDescriptionDisabled()

Returns true if the object description cannot be set/changed from the Editor. This is here mainly because ObjEditor has this method and the locNamesPrimaryNameView uses this to determine whether or not to display the description field and js validation. For our proposes, we will always display the discription field. So this will always return false.

Specified by:

IsDescriptionDisabled in interface IDescriptionModelRO

Returns:

boolean

See Also:

ObjEditorModel.IsDescriptionDisabled()

SavePage

public int SavePage(java.lang.String _sPageName,
                    XPHashtable _htFormData)

Calls the right save function according to the page name passed in argument.

Specified by:

SavePage in interface IRepostModel

Specified by:

SavePage in class EditorModel

Parameters:

_sPageName -

_htFormData -

Returns:

int Page status for server side validation

CheckActivityRight

protected boolean CheckActivityRight()

Helper method to determine activity rights.

StoreObject

protected void StoreObject(IPTObject _object,
                           java.lang.String _key)

Helper method to Store the Object.

GetProfilePage

public IPTProfilePage GetProfilePage()

returns the Layout object that represents the current user profile layout

Specified by:

GetProfilePage in interface IEODPortletPrefsModelRO

Returns:

Layout

GetPortletID

public int GetPortletID()

Specified by:

GetPortletID in interface IEODPortletPrefsModelRO

Returns: