com.plumtree.portalpages.admin.ptutilities.migrationutility
Class MigrationUtilityAS

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.portalpages.admin.ptutilities.migrationutility.MigrationUtilityAS

All Implemented Interfaces:

IManagedObject, IMVCObject, IFormAS, IEnvironment

Direct Known Subclasses:

MigrationUtilityExportAS, MigrationUtilityImportAS

public class MigrationUtilityAS
extends PTEditorAS

Author:

jennifersu

Field Summary

protected int	m_intMode Migration Mode (export or import)
static int	MODE_EXPORT Export mode
static int	MODE_IMPORT Import mode
static java.lang.String	STR_MVC_CLASS_NAME
static java.lang.String	strStorageRepostControl

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

MigrationUtilityAS()

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	GetEditorTitle() Returns the Editor main title.
java.lang.String	GetName() This method is used to identify the type of this space.
java.lang.String	GetRepostControlName() Returns the class name of the Editor Repost Control.
int	GetResourcesSubMenuID() Get "Resources" submenu ID
int	GetSettingsSubMenuID() Get "Utility Settings" submenu ID
void	Init() Registers Views, Controls and Models used by the Editor Framework.
void	InitXUIClasses(XPHashtable _htPageCounts, int _intNumServices) Registers XUI classes.
void	SetCurrentPage(IDisplayPage page) Set the current page for this AActivitySpace.

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

DisplayCommonJavaScript

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

DeleteSubEditorFromList, GetLeftMenu, GetPreviousPage, GetSubBanner, GoToSubEditor, SetCurrentPage

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, 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

strStorageRepostControl

public static final java.lang.String strStorageRepostControl

See Also:

Constant Field Values

MODE_EXPORT

public static final int MODE_EXPORT

Export mode

See Also:

Constant Field Values

MODE_IMPORT

public static final int MODE_IMPORT

Import mode

See Also:

Constant Field Values

m_intMode

protected int m_intMode

Migration Mode (export or import)

Constructor Detail

MigrationUtilityAS

public MigrationUtilityAS()

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

GetEditorTitle

public java.lang.String GetEditorTitle()

Description copied from class: EditorAS

Returns the Editor main title. It will get printed out in EditorHeaderView.

Specified by:

GetEditorTitle in class EditorAS

Returns:

String

See Also:

EditorAS.GetEditorTitle()

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 AFormAS

Returns:

String the name of this AActivitySpace

See Also:

IMVCObject.GetName()

GetRepostControlName

public java.lang.String GetRepostControlName()

Description copied from class: PTEditorAS

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

See Also:

com.plumtree.uiinfrastructure.form.IRepostAS#GetRepostControlName()

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)

Init

public void Init()

Description copied from class: EditorAS

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

InitXUIClasses

public void InitXUIClasses(XPHashtable _htPageCounts,
                           int _intNumServices)

Registers XUI classes. Also sets the left navigation menu.

Parameters:

_nPageCount - Number of XUI pages.

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

GetSettingsSubMenuID

public int GetSettingsSubMenuID()

Get "Utility Settings" submenu ID

Returns:

GetResourcesSubMenuID

public int GetResourcesSubMenuID()

Get "Resources" submenu ID

Returns: