com.plumtree.portaluiinfrastructure.editor
Class ObjEditorAS

java.lang.Object
  com.plumtree.uiinfrastructure.activityspace.AActivitySpace
      com.plumtree.uiinfrastructure.form.AFormAS
          com.plumtree.uiinfrastructure.editor.EditorAS
              com.plumtree.portaluiinfrastructure.editor.PTEditorAS
                  com.plumtree.portaluiinfrastructure.editor.ObjEditorAS

All Implemented Interfaces:

IManagedObject, IMVCObject, IFormAS, IEnvironment

Direct Known Subclasses:

AdminFolderEditorAS, AuthSourceEditorAS, CardEditorAS, CommunityEditorAS, CommunityTemplateEditorAS, CrawlerEditorAS, DocTypeEditorAS, DSEditorAS, EODPortletPrefsEditorAS, ExternalOperationEditorAS, FilterEditorAS, FolderEditorAS, GbDocTypeEditorAS, GbDocTypeExtEditorAS, GroupEditorAS, InvitationEditorAS, JobEditorAS, MultipleCardLinkSettingsAS, NetSearchEditorAS, NetSearchEditorAS, ObjPropEditorAS, OutgoingNSEditorAS, PageEditorAS, PageTemplateEditorAS, PlumtreeAuthSourceEditorAS, PortletBundleEditorAS, PortletEditorAS, ProfileSourceEditorAS, PropEditorAS, PropertyMapEditorAS, RemoteServerEditorAS, RuleEditorAS, SavedSearchEditorAS, SiteMapFolderEditorAS, SmartSortEditorAS, SOAPCardSubmitAdvancedAS, SubPortalAS, UserEditorAS, UsrProfMgrEditorAS, WebServiceEditorAS, WWWCardSubmitAdvancedAS

public abstract class ObjEditorAS
extends PTEditorAS

This is the Activity Space class for the ObjEditor Framework. Editor Activity Space classes should extend this class.

Author:

Julie Fournier

Field Summary

static java.lang.String	JAVASCRIPT_OBJEDITOR_OPEN Javascript function name
static java.lang.String	SAVEOBJECT_SUBSPACE_KEY Key for the AS to store the save object pop-up as a sub space.
static java.lang.String	STR_MVC_STORAGE_NAME_KEYWORDS MJD- Storage name for Keywords classes
static java.lang.String	STR_MVC_STORAGE_NAME_PRIORITY_DROP_DOWN JF- Storage name for Priority drop-down classes
static java.lang.String	STR_MVC_STORAGE_NAME_SECURITY_TAB JF- Storage name for Security classes

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

m_mEditorMenu, m_strModelMVCName, m_strModelName

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

ObjEditorAS()

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.
HTMLScriptCollection	DisplayCommonJavaScript() This is a helper method that all classes that inherit from AFormDP can override if they like.
java.lang.String	GetDependenciesViewName() Returns the class name of the Dependencies Section.
java.lang.String	GetObjectName() Returns the truncated name of the object being created or edited.
java.lang.String	GetRepostControlName() Returns the class name of the Editor Repost Control.
void	Init() Registers Views, Controls and Models used by the Editor Framework.
void	SetCurrentPage(IDisplayPage page) Set the current page for this AActivitySpace.

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

DeleteSubEditorFromList, GetEditorTitle, GetLeftMenu, GetPreviousPage, GetSubBanner, GoToSubEditor, SetCurrentPage

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

GetName

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

ChangeSubSpaceKey, CleanupAllData, CleanupTempData, Create, 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, 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_STORAGE_NAME_KEYWORDS

public static final java.lang.String STR_MVC_STORAGE_NAME_KEYWORDS

MJD- Storage name for Keywords classes

See Also:

Constant Field Values

STR_MVC_STORAGE_NAME_SECURITY_TAB

public static final java.lang.String STR_MVC_STORAGE_NAME_SECURITY_TAB

JF- Storage name for Security classes

See Also:

Constant Field Values

STR_MVC_STORAGE_NAME_PRIORITY_DROP_DOWN

public static final java.lang.String STR_MVC_STORAGE_NAME_PRIORITY_DROP_DOWN

JF- Storage name for Priority drop-down classes

See Also:

Constant Field Values

JAVASCRIPT_OBJEDITOR_OPEN

public static final java.lang.String JAVASCRIPT_OBJEDITOR_OPEN

Javascript function name

See Also:

Constant Field Values

SAVEOBJECT_SUBSPACE_KEY

public static final java.lang.String SAVEOBJECT_SUBSPACE_KEY

Key for the AS to store the save object pop-up as a sub space.

See Also:

Constant Field Values

Constructor Detail

ObjEditorAS

public ObjEditorAS()

Method Detail

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 EditorAS

Returns:

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

See Also:

com.plumtree.portaluiinfrastructure.activityspace.AActivitySpace#CheckBasicAccess(String, String, boolean)

DisplayCommonJavaScript

public HTMLScriptCollection DisplayCommonJavaScript()

Description copied from class: AFormAS

This is a helper method that all classes that inherit from AFormDP can override if they like. The method provides a hook into the head so that DP's can add javascript. Simply override and return and HTMLScript. Also, it is best to return the results of the DisplayJavaScript functions from the appropriate views. Override this method to Display javascript from child IViews

Specified by:

DisplayCommonJavaScript in interface IFormAS

Overrides:

DisplayCommonJavaScript in class PTEditorAS

Returns:

HTMLScriptCollection the Javascript from the Child IViews

See Also:

IFormAS.DisplayCommonJavaScript()

GetDependenciesViewName

public java.lang.String GetDependenciesViewName()

Returns the class name of the Dependencies Section. This page will be displayed at the end of the save pop-up. It will inform the user that the Object was successfully created and can also include some intructions on what to do next. Object Editors should override this method if they have their own implementation of ObjDependenciesView.

Returns:

String

GetObjectName

public java.lang.String GetObjectName()

Returns the truncated name of the object being created or edited.

Returns:

String

GetRepostControlName

public java.lang.String GetRepostControlName()

Returns the class name of the Editor Repost Control. Editors should also implement that method and return the name of their own repost control, unless they don't have any. In that case they don't need to implement the method and EditorRepostControl will be used by default.

Specified by:

GetRepostControlName in interface IFormAS

Overrides:

GetRepostControlName in class PTEditorAS

Returns:

String

Init

public void Init()

Registers Views, Controls and Models used by the Editor Framework. Warning: m_myModel must be set before calling Init().

Overrides:

Init in class EditorAS

See Also:

AActivitySpace.Init()

SetCurrentPage

public void SetCurrentPage(IDisplayPage page)

Description copied from class: AActivitySpace

Set the current page for this AActivitySpace. If this AActivitySpace only has one IDisplayPage, the current page will automatically be set to that IDisplayPage. If current page tracking is on (off by default), the Interpeter will set the current page to be the most recently accessed page.

Overrides:

SetCurrentPage in class EditorAS

Parameters:

IDisplayPage - the current Display Page

See Also:

com.plumtree.uiinfrastructure.activityspace.AActivitySpace#SetCurrentPage()