com.plumtree.uiinfrastructure.help
Class HelpFrameAS

java.lang.Object
  extended by com.plumtree.uiinfrastructure.activityspace.AActivitySpace
      extended by com.plumtree.uiinfrastructure.help.HelpFrameAS
All Implemented Interfaces:
IManagedObject, IMVCObject, IEnvironment

public class HelpFrameAS
extends AActivitySpace

Author:
donh This Activity Space provides a frameset with a "back" navigation link at the bottom for 508 users.

Field Summary
 java.lang.String m_strHelpTopic
           
 java.lang.String m_strPreviousRequestURL
           
static java.lang.String STR_MVC_CLASS_NAME
          MVC object name
 
Fields inherited from class com.plumtree.uiinfrastructure.activityspace.AActivitySpace
m_stringReferences
 
Constructor Summary
HelpFrameAS()
           
 
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.
 void Init()
          Initialize the Activity Space.
 
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, GetStyleSheetLinks, GetSubSession, GetSubSpace, GetSubSpaceExists, GetSubSpaceKey, GetSubSpacesEnumerator, GetTimeZone, GetUserSession, GetVarPack, GetView, GetViewExists, GetViewsEnumerator, IsSubSpace, refString, RegisterControl, RegisterControl, RegisterModel, RegisterModel, RegisterPage, RegisterPage, RegisterSubSpace, RegisterView, RegisterView, ReInit, 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
MVC object name

See Also:
Constant Field Values

m_strPreviousRequestURL

public java.lang.String m_strPreviousRequestURL

m_strHelpTopic

public java.lang.String m_strHelpTopic
Constructor Detail

HelpFrameAS

public HelpFrameAS()
Method Detail

Init

public void Init()
Initialize the Activity Space.

Overrides:
Init in class AActivitySpace

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

Specified by:
CheckBasicAccess in class AActivitySpace
Returns:
boolean true implies access is allowed, false implies access is denied

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

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 AActivitySpace
Returns:
String the name of this AActivitySpace



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