com.plumtree.portalpages.portlets.sitemap
Class SiteMapPortletModel

java.lang.Object
  com.plumtree.uiinfrastructure.activityspace.AClearModel
      com.plumtree.portaluiinfrastructure.intrinsicportlets.IntrinsicPortletModel
          com.plumtree.portalpages.portlets.sitemap.SiteMapPortletModel

All Implemented Interfaces:

ISiteMapPortletModelRO, IIntrinsicPortletModelRO, IManagedObject, IModel, IModelRO, IMVCObject, IRepostModel

public class SiteMapPortletModel
extends IntrinsicPortletModel
implements ISiteMapPortletModelRO, IRepostModel

Author:

josephc

Field Summary

static java.lang.String

STR_MVC_CLASS_NAME Class name for the model

Fields inherited from class com.plumtree.portaluiinfrastructure.intrinsicportlets.IntrinsicPortletModel

m_asOwner, m_nContainerClassID, m_nContainerObjectID, m_nPageID, m_nPortletID, m_nPrefType, m_ptAppDataState, m_ptPortlet, m_ptSession, PREF_TYPE_ADMIN, PREF_TYPE_COMMUNITY, PREF_TYPE_PERSONAL, SETTINGSTYPE_ADMIN, SETTINGSTYPE_COMMUNITY, SETTINGSTYPE_COMMUNITYPORTLET, SETTINGSTYPE_PORTLET, SETTINGSTYPE_USER

Constructor Summary

SiteMapPortletModel()

Method Summary

boolean	ControlExists() Returns true if the portlet has a control associated with it.
java.lang.Object	Create() This method is used by the ASManager to return new instances of managed objects.
void	Finish() Implement some code to execute when the user clicks on "Finish".
int	GetCommunityID()
java.lang.String	GetData()
int	GetFolderID()
java.lang.String	GetFolderName()
boolean	GetHasEditAccessToCommunity()
boolean	GetHasEditAccessToFolder()
boolean	GetHasReadAccessToFolder()
ICPListEntryIterator	GetLinks()
java.lang.String	GetName() Returns the Class name.
java.lang.Object	GetNewTempData() This method returns a new temporary data object.
int	GetNumLinksToDisplay()
java.lang.String	GetPrefsURL()
Redirect	GetRedirectAfterFinish() Returns the Redirect object (this is were we need to go at the end of the Editor).
int	SavePage(java.lang.String _sPageName, XPHashtable _htFormData) Calls the right save function according to the page name passed in argument.
void	SetData(java.lang.String strData)
void	SetFolderID(int nFolderID)
boolean	ShowDescriptions()
boolean	ShowMoreLink()

Methods inherited from class com.plumtree.portaluiinfrastructure.intrinsicportlets.IntrinsicPortletModel

CleanupAllData, CleanupTempData, GetPortletID, GetSettingValue, GetSettingValues, Init, InitPortlet, IsIntrinsicPortlet

Methods inherited from class com.plumtree.uiinfrastructure.activityspace.AClearModel

GetTempData

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.IIntrinsicPortletModelRO

GetPortletID

Methods inherited from interface com.plumtree.uiinfrastructure.activityspace.IModel

CleanupAllData, CleanupTempData, Init

Field Detail

STR_MVC_CLASS_NAME

public static final java.lang.String STR_MVC_CLASS_NAME

Class name for the model

See Also:

Constant Field Values

Constructor Detail

SiteMapPortletModel

public SiteMapPortletModel()

Method Detail

ControlExists

public boolean ControlExists()

Description copied from class: IntrinsicPortletModel

Returns true if the portlet has a control associated with it. This function should be implemented by the child class.

Specified by:

ControlExists in interface IIntrinsicPortletModelRO

Specified by:

ControlExists in class IntrinsicPortletModel

Returns:

See Also:

IIntrinsicPortletModelRO.ControlExists()

Create

public java.lang.Object Create()

Description copied from class: AClearModel

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 AClearModel

Returns:

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

See Also:

IManagedObject.Create()

Finish

public void Finish()

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

Specified by:

Finish in interface IRepostModel

GetCommunityID

public int GetCommunityID()

Specified by:

GetCommunityID in interface ISiteMapPortletModelRO

Returns:

GetData

public java.lang.String GetData()

Specified by:

GetData in interface ISiteMapPortletModelRO

Returns:

Throws:

XPException

GetFolderID

public int GetFolderID()

Specified by:

GetFolderID in interface ISiteMapPortletModelRO

Returns:

GetFolderName

public java.lang.String GetFolderName()

Specified by:

GetFolderName in interface ISiteMapPortletModelRO

Returns:

GetHasEditAccessToCommunity

public boolean GetHasEditAccessToCommunity()

Specified by:

GetHasEditAccessToCommunity in interface ISiteMapPortletModelRO

Returns:

GetHasEditAccessToFolder

public boolean GetHasEditAccessToFolder()

Specified by:

GetHasEditAccessToFolder in interface ISiteMapPortletModelRO

Returns:

GetHasReadAccessToFolder

public boolean GetHasReadAccessToFolder()

Specified by:

GetHasReadAccessToFolder in interface ISiteMapPortletModelRO

Returns:

GetLinks

public ICPListEntryIterator GetLinks()

Specified by:

GetLinks in interface ISiteMapPortletModelRO

Returns:

GetName

public java.lang.String GetName()

Returns the Class name.

Specified by:

GetName in interface IMVCObject

Specified by:

GetName in class IntrinsicPortletModel

Returns:

String

See Also:

IMVCObject.GetName()

GetNewTempData

public java.lang.Object GetNewTempData()

Description copied from class: AClearModel

This method returns a new temporary data object. It is called at the beginning of a new HTTP Request. This method can perform initialization on the data object if necessary.

Specified by:

GetNewTempData in class AClearModel

Returns:

GetNumLinksToDisplay

public int GetNumLinksToDisplay()

Specified by:

GetNumLinksToDisplay in interface ISiteMapPortletModelRO

Returns:

See Also:

ISiteMapPortletModelRO.GetNumLinksToDisplay()

GetPrefsURL

public java.lang.String GetPrefsURL()

Specified by:

GetPrefsURL in interface ISiteMapPortletModelRO

Returns:

GetRedirectAfterFinish

public Redirect GetRedirectAfterFinish()

Returns the Redirect object (this is were we need to go at the end of the Editor).

Specified by:

GetRedirectAfterFinish in interface IRepostModel

Returns:

Redirect

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

Parameters:

_sPageName -

_htFormData -

Returns:

SetData

public void SetData(java.lang.String strData)

Parameters:

strData -

Throws:

XPException

SetFolderID

public void SetFolderID(int nFolderID)

ShowDescriptions

public boolean ShowDescriptions()

Specified by:

ShowDescriptions in interface ISiteMapPortletModelRO

Returns:

See Also:

ISiteMapPortletModelRO.ShowDescriptions()

ShowMoreLink

public boolean ShowMoreLink()

Specified by:

ShowMoreLink in interface ISiteMapPortletModelRO

Returns: