com.plumtree.portalpages.browsing.editors.sitemap
Class SiteMapFolderModel

java.lang.Object
  com.plumtree.uiinfrastructure.editor.EditorModel
      com.plumtree.portaluiinfrastructure.editor.ObjEditorModel
          com.plumtree.portalpages.browsing.editors.sitemap.SiteMapFolderModel

All Implemented Interfaces:

ISiteMapFolderRO, IDescriptionModelRO, IMigrationModelRO, IObjEditorModelRO, IManagedObject, IModel, IModelRO, IMVCObject, IEditorModelRO, IRepostModel

public class SiteMapFolderModel
extends ObjEditorModel
implements ISiteMapFolderRO

File: SiteMapFolderModel.java -----------------------------

Author:

NaveenP

Field Summary

static int	EDIT_TYPE_NAME_DESC Constant representing the name and description page
static int	EDIT_TYPE_SECURITY Constant representing the security page
static int	NO_PARENT Constant indicating no parent admin folder
static java.lang.String	QS_LOCALIZEDNAME Query string argument indicating to show localized names page only
static java.lang.String	QS_NAMEORSECURITY The edit type query string argument
static java.lang.String	QS_PARENTFOLDERID The parent folder id query string argment
static java.lang.String	QS_STARTEDINSITEMAP Query string argument indicating the starting context for the editor
static java.lang.String	STR_MVC_CLASS_NAME Unique identifier for the class

Fields inherited from class com.plumtree.portaluiinfrastructure.editor.ObjEditorModel

EDITOR_CLASSID_UNKNOWN, EDITOR_FOLDERID_UNKNOWN, EDITOR_OBJECTID_UNKNOWN, EDITOR_QS_BOL_QS_FORCESAVEINFOLDER, EDITOR_QS_INT_CLASS_ID, EDITOR_QS_INT_QS_FOLDER_ID, EDITOR_QS_INT_QS_OBJECT_ID, m_bDisableDescription, m_bDisableSecurity, m_bForceSavedInSuppliedFolder, m_bIsSysAdmin, m_nClassID, m_nFolderID, m_nFolderType, m_nObjectID, m_ptObject, m_Session, m_sFolderName, OBJECT_NAME_TRUNCATE

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

SiteMapFolderModel()

Method Summary

protected boolean	CheckEditorAccess(XPHashtable _htFormData) Helper method to check the current user rights to this Object Editor.
java.lang.Object	Create() This method is used by the ASManager to return new instances of managed objects.
void	DeleteFolderOnCancel() This function cleans up the folder created at the outset if the user cancels the editor
void	DoInitialStore() This function saves the site map link folder at the outset, at least temporarily, so we can add links to it.
void	DoTaskOnStartEditor(XPHashtable _htFormData) Initializes member variables when the editor starts
boolean	FolderHasParent()
java.lang.String	GetName() Returns the Class name.
Redirect	GetRedirectAfterFinish() Returns Redirect object where the Framework should redirect to on Finish.
boolean	GetStartedInSiteMap() Returns true if the editor was started in the site map
void	InitializeSiteMapPlugIn() Helper method to initialize the plug-in section for navigation link creation
protected void	InitPTObject(XPHashtable _htFormData) Initializes the object being created or edited with this editor
protected int	SaveEditLinkPage(XPHashtable _htFormData) Saves the values from the edit link page into member variables.
int	SavePage(java.lang.String _sPageName, XPHashtable _htFormData) Calls the right save function according to the page name passed in argument.

Methods inherited from class com.plumtree.portaluiinfrastructure.editor.ObjEditorModel

CheckEditorAccessAndStart, CheckFolderType, DisableSecurity, DoTaskOnComeBackFromSubEditor, Finish, ForceSaveInFolder, GetClassID, GetFolderID, GetFolderName, GetIsSysAdmin, GetMigrationStatus, GetObject, GetObjectDescription, GetObjectID, GetObjectName, GetParentFolderPath, GetPTSession, Init, InitIsSysAdminFlag, IsDescriptionDisabled, IsMigrationApproved, SaveMigrationStatus, SetDisableDescription, SetEditorToReadOnly, SetMemberVariablesFromQS, SetMigrationStatus, StartKeywords, StartLocNamesList, StartMigrationHistory, StartObjectProp, StartSecurityList, StoreObject

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

Cancel, CleanupAllData, CleanupTempData, DoTaskAfterStore, DoTaskBeforeStore, DoTaskOnChangePage, GetAccessToEditorPriviledges, GetCloseOnDone, GetCurrentRepostAction, GetDeleteOnCancel, GetEditorType, GetEnableApplyButton, GetEnableCancelButton, GetHideLeftNav, GetIsEditorReadOnly, GetUserHasAccessToEditor, SetCloseOnDone, SetDeleteOnCancel, SetEditorType, SetEnableApplyButton, 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.editor.IObjEditorModelRO

GetClassID, GetObject, GetObjectDescription, GetObjectID, GetObjectName, GetParentFolderPath, GetPTSession

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

Unique identifier for the class

See Also:

Constant Field Values

QS_PARENTFOLDERID

public static final java.lang.String QS_PARENTFOLDERID

The parent folder id query string argment

See Also:

Constant Field Values

QS_NAMEORSECURITY

public static final java.lang.String QS_NAMEORSECURITY

The edit type query string argument

See Also:

Constant Field Values

QS_STARTEDINSITEMAP

public static final java.lang.String QS_STARTEDINSITEMAP

Query string argument indicating the starting context for the editor

See Also:

Constant Field Values

QS_LOCALIZEDNAME

public static final java.lang.String QS_LOCALIZEDNAME

Query string argument indicating to show localized names page only

See Also:

Constant Field Values

EDIT_TYPE_NAME_DESC

public static final int EDIT_TYPE_NAME_DESC

Constant representing the name and description page

See Also:

Constant Field Values

EDIT_TYPE_SECURITY

public static final int EDIT_TYPE_SECURITY

Constant representing the security page

See Also:

Constant Field Values

NO_PARENT

public static final int NO_PARENT

Constant indicating no parent admin folder

See Also:

Constant Field Values

Constructor Detail

SiteMapFolderModel

public SiteMapFolderModel()

Method Detail

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

DeleteFolderOnCancel

public void DeleteFolderOnCancel()

This function cleans up the folder created at the outset if the user cancels the editor

DoInitialStore

public void DoInitialStore()

This function saves the site map link folder at the outset, at least temporarily, so we can add links to it.

DoTaskOnStartEditor

public void DoTaskOnStartEditor(XPHashtable _htFormData)

Initializes member variables when the editor starts

Overrides:

DoTaskOnStartEditor in class EditorModel

Parameters:

_htFormData -

InitializeSiteMapPlugIn

public void InitializeSiteMapPlugIn()

Helper method to initialize the plug-in section for navigation link creation

FolderHasParent

public boolean FolderHasParent()

Returns:

boolean

GetName

public java.lang.String GetName()

Returns the Class name.

Specified by:

GetName in interface IMVCObject

Specified by:

GetName in class EditorModel

Returns:

String

GetRedirectAfterFinish

public Redirect GetRedirectAfterFinish()

Returns Redirect object where the Framework should redirect to on Finish.

Specified by:

GetRedirectAfterFinish in interface IRepostModel

Overrides:

GetRedirectAfterFinish in class EditorModel

Returns:

Redirect

GetStartedInSiteMap

public boolean GetStartedInSiteMap()

Description copied from interface: ISiteMapFolderRO

Returns true if the editor was started in the site map

Specified by:

GetStartedInSiteMap in interface ISiteMapFolderRO

Returns:

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

Overrides:

SavePage in class ObjEditorModel

Parameters:

_sPageName -

_htFormData -

Returns:

int Page status for server side validation

CheckEditorAccess

protected boolean CheckEditorAccess(XPHashtable _htFormData)

Helper method to check the current user rights to this Object Editor.

Overrides:

CheckEditorAccess in class ObjEditorModel

Parameters:

_htFormData - Form data

Returns:

boolean

InitPTObject

protected void InitPTObject(XPHashtable _htFormData)

Initializes the object being created or edited with this editor

Overrides:

InitPTObject in class ObjEditorModel

SaveEditLinkPage

protected int SaveEditLinkPage(XPHashtable _htFormData)

Saves the values from the edit link page into member variables. In this case, it actually just replaces the copy of the object we have with the one it retrieves from the plug-in section.

Parameters:

_htFormData -

Returns:

int