com.plumtree.portalpages.browsing.sitemap.sitemappage
Class SiteMapAS

java.lang.Object
  com.plumtree.uiinfrastructure.activityspace.AActivitySpace
      com.plumtree.uiinfrastructure.form.AFormAS
          com.plumtree.portalpages.common.uiparts.PlumtreeAS
              com.plumtree.portalpages.browsing.sitemap.sitemappage.SiteMapAS

All Implemented Interfaces:

ITypes, IManagedObject, IMVCObject, IFormAS, IEnvironment

public class SiteMapAS
extends PlumtreeAS

File: SiteMapAS.java --------------------

Author:

NaveenP

Field Summary

static java.lang.String	s_strCommSelectionFolderView
static java.lang.String	s_strMembersObjectView
static java.lang.String	s_strSubCommunitiesObjectView
static java.lang.String	STR_MVC_CLASS_NAME

Fields inherited from class com.plumtree.portalpages.common.uiparts.PlumtreeAS

REGISTERED_VIEW_SESSION_ATTRIBUTE

Fields inherited from class com.plumtree.uiinfrastructure.form.AFormAS

JAVASCRIPT_GVAR_PTHELPSVRBASEURL, JAVASCRIPT_GVAR_PTIMGSVRIMGSURL, JAVASCRIPT_GVAR_SHAREDIMGSVRIMGSURL

Fields inherited from class com.plumtree.uiinfrastructure.activityspace.AActivitySpace

m_stringReferences

Constructor Summary

SiteMapAS()

Method Summary

boolean	CheckBasicAccess(java.lang.String strPage, java.lang.String strControl, boolean bSameSpace) This method is called by the Interpreter at the beginning of every HTTP request to determine whether or not the current user has the security privileges necessary to view the requested page.
java.lang.Object	Create() This method is used by the ASManager to return new instances of managed objects.
java.lang.String	GetName() This method is used to identify the type of this space.
java.lang.String	GetRepostControlName() Returns the name of the repost control class.
HTMLElementCollection	GetStyleSheetLinks() Figure out the style sheet; this method can be overriden by classes that require a special style sheet.
void	Init() Initialize the Activity Space.

Methods inherited from class com.plumtree.portalpages.common.uiparts.PlumtreeAS

DisplayCommonJavaScript, GetNavType, GetStrLayoutStyleClass, ReInit, SetStrLayoutStyleClass

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

ChangeSubSpaceKey, CleanupAllData, CleanupTempData, DeleteSubSpace, GetAccessStyle, GetApplication, GetControl, GetControlExists, GetControlsEnumerator, GetCurrentFormData, GetCurrentHTTPRequest, GetCurrentHTTPResponse, GetCurrentNormalizedBaseURL, GetCurrentPage, GetCurrentRequestURL, GetHelpTopic, GetIsAccessStyleNonStandard, GetIsAccessStyleStandard, GetIsInPlaceRefreshDisplayOn, GetIsInPlaceRefreshEnabled, GetIsSecuredSpace, GetLanguage, GetLocale, GetModel, GetModelExists, GetModelsEnumerator, GetPage, GetPageExists, GetPagesEnumerator, GetParentSpace, GetParentSpaceID, GetParentSpaceName, GetPersistentSubSession, GetResourceManager, GetSpaceID, GetString, GetSubSession, GetSubSpace, GetSubSpaceExists, GetSubSpaceKey, GetSubSpacesEnumerator, GetTimeZone, GetUserSession, GetVarPack, GetView, GetViewExists, GetViewsEnumerator, IsSubSpace, refString, RegisterControl, RegisterControl, RegisterModel, RegisterModel, RegisterPage, RegisterPage, RegisterSubSpace, RegisterView, RegisterView, SetApplication, SetCurrentFormData, SetCurrentHTTPRequestResponseObjects, SetCurrentPage, SetCurrentRequestURL, SetHelpTopic, SetIsASSecured, SetIsInPlaceRefreshDisplayOn, SetIsInPlaceRefreshEnabled, SetOverWriteSubSpaces, SetParentSpace, SetPersistentSubSession, SetSpaceID, SetSubSession, SetSubSpaceKey, SetTrackCurrentPage, SetUserSession, unrefString, UnRegisterControl, UnRegisterModel, UnRegisterPage, UnRegisterView

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

s_strCommSelectionFolderView

public static final java.lang.String s_strCommSelectionFolderView

See Also:

Constant Field Values

s_strMembersObjectView

public static final java.lang.String s_strMembersObjectView

See Also:

Constant Field Values

s_strSubCommunitiesObjectView

public static final java.lang.String s_strSubCommunitiesObjectView

See Also:

Constant Field Values

Constructor Detail

SiteMapAS

public SiteMapAS()

Method Detail

Create

public java.lang.Object Create()

Description copied from class: AActivitySpace

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 AActivitySpace

Returns:

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

See Also:

IManagedObject.Create()

GetName

public java.lang.String GetName()

Description copied from class: AActivitySpace

This method is used to identify the type of this space.

Specified by:

GetName in interface IMVCObject

Specified by:

GetName in class PlumtreeAS

Returns:

String the name of this AActivitySpace

See Also:

com.plumtree.xpshared.activityspace.IActivitySpace#GetName()

CheckBasicAccess

public boolean CheckBasicAccess(java.lang.String strPage,
                                java.lang.String strControl,
                                boolean bSameSpace)

Description copied from class: AActivitySpace

This method is called by the Interpreter at the beginning of every HTTP request to determine whether or not the current user has the security privileges necessary to view the requested page. This method is designed for checking whether or not a particular user has any access to the space, page, and control. More detailed checking (of query string parameters, for instance), should be done in the IControl.CheckActionSecurityAndExecute() method. For Plumtree portal applications (IPTActivitySpaces), since the IPTSession is guaranteed to be set before Init() & CheckBasicAccess() are called, you can check access as follows: return (GetIPTSession().GetSessionInfo().CheckForActivityRight (new Integer(PT_ACTIVITY_RIGHTS.PT_ACTIVITY_RIGHT_ACCESS_ADMINISTRATION)) == 1);

Overrides:

CheckBasicAccess in class PlumtreeAS

Returns:

boolean true implies access is allowed, false implies access is denied

See Also:

AS that extends PlumtreeAS must call this super method if overridden to check for changed navigation scheme

GetRepostControlName

public java.lang.String GetRepostControlName()

Description copied from class: AFormAS

Returns the name of the repost control class. E.g.: PropRepostControl.GetName() This can also be overridden on a per DP basis. See AFormDP#GetRepostControlName() The repost control does not necessarily need to extend RepostControl. A form can be submitted to any type of control as long as it knows how to properly interpret the form.

Specified by:

GetRepostControlName in interface IFormAS

Overrides:

GetRepostControlName in class AFormAS

Returns:

Init

public void Init()

Description copied from class: AActivitySpace

Initialize the Activity Space. This method is called after common attributes like ID, parent, session, application, etc... are set. Get methods are not valid until this method is called. This method should be overridden and called as super.Init();

Overrides:

Init in class PlumtreeAS

See Also:

com.plumtree.xpshared.activityspace.IActivitySpace#Init()

GetStyleSheetLinks

public HTMLElementCollection GetStyleSheetLinks()

Description copied from class: AActivitySpace

Figure out the style sheet; this method can be overriden by classes that require a special style sheet.

Overrides:

GetStyleSheetLinks in class AActivitySpace

Returns:

An HTMLCollection that contains one or more PTStyleSheetLink objects (almost always just one)

See Also:

com.plumtree.xpshared.activityspace.AActivitySpace#GetStyleSheetLinks()