com.plumtree.portalpages.admin.editors.adminfolder
Class AdminFolderModel

java.lang.Object
  com.plumtree.uiinfrastructure.editor.EditorModel
      com.plumtree.portaluiinfrastructure.editor.ObjEditorModel
          com.plumtree.portalpages.admin.editors.adminfolder.AdminFolderModel

All Implemented Interfaces:

IDescriptionModelRO, IMigrationModelRO, IObjEditorModelRO, IFolderSecurityABOModelRO, ISecurityMatrixModelRO, IManagedObject, IModel, IModelRO, IMVCObject, IEditorModelRO, IRepostModel

public class AdminFolderModel
extends ObjEditorModel
implements ISecurityMatrixModelRO

This class contains the IPTProperty server object, as well as the set and get methods on that object. This class is called by the AdminFolderRepostControl to perform the changes on the Object and by the Views AdminFolderAdvView and AdminFolderMainView to display the latest values on the page.

Author:

RickyW

Field Summary

static java.lang.String	BR_ELEMENT
static int	CLIENT_VALIDATION_MAX_NAME RWW - Constants for client side validation
static java.lang.String	STR_MVC_CLASS_NAME class name

Fields inherited from class com.plumtree.portaluiinfrastructure.editor.ObjEditorModel

EDITOR_CLASSID_UNKNOWN, EDITOR_FOLDERID_UNKNOWN, EDITOR_OBJECTID_UNKNOWN, EDITOR_QS_BOL_QS_FORCESAVEINFOLDER, EDITOR_QS_INT_CLASS_ID, EDITOR_QS_INT_QS_FOLDER_ID, EDITOR_QS_INT_QS_OBJECT_ID, m_bDisableDescription, m_bDisableSecurity, m_bForceSavedInSuppliedFolder, m_bIsSysAdmin, m_nClassID, m_nFolderID, m_nFolderType, m_nObjectID, m_ptObject, m_Session, m_sFolderName, OBJECT_NAME_TRUNCATE

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

isReadAccessAvailable, m_asOwner, m_bCloseOnDone, m_bDeleteOnCancel, m_bEnableApplyButton, m_bEnableCancelButton, m_bHideLeftNav, m_bIsEditorReadOnly, m_bUserHasAccessToEditor, m_nEditorType

Constructor Summary

AdminFolderModel()

Method Summary

boolean	ABOJobIDToDisplay() This method returns whether or not there is a job ID to display.
void	ApplySecurityChangesUsingABO(boolean bPropagateAllACLs) Apply the subportal profile to the users in the folder later, using ABO.
java.lang.Object	Create() This method is used by the ASManager to return new instances of managed objects.
void	DoTaskAfterStore() Code executed after done is clicked, after object is saved.
void	DoTaskBeforeStore() Code executed after done is clicked, before object is saved.
void	DoTaskOnComeBackFromSubEditor() This method will be called when you come back to the main Editor from a sub Editor.
void	DoTaskOnStartEditor(XPHashtable _htFormData) Initialize any settings here.
int	GetABOJobID() This method returns the job ID for a security change job.
java.lang.String	GetCreatedJobName() Retrieves the name of the job created by ABO.
IPTAccessList	GetCurrentFolderACL()
ASURL	GetEditObjectURL(int _nClassID, int _nObjectID) Returns the URL to edit the object.
java.lang.String	GetFolderNameForCreatedJobs() Retrieves the name of the folder that ABO created the job in.
java.lang.String	GetName() Returns the Class name.
int	GetNumSubPortals() Returns the number of SubPortals that were loaded.
java.lang.String	GetRegularFolderID() Returns the id of a regular folder.
java.lang.String	GetSelectedSubPortalID() Returns the id of the selected subportal.
java.lang.String	GetSubPortalID(int pos) Returns the id of the subportal at a given position.
java.lang.String	GetSubPortalName(int pos) Returns the name of the subportal at a given position.
boolean	IsAdminModifiedOnFolder(IPTAccessList _ptOldACL)
void	RaiseError(java.lang.String strError)
void	RepostAdvPage() Does nothing for now.
protected int	SaveAdvPage(XPHashtable _htFormData) Saves the data on the Advanced page.
int	SavePage(java.lang.String _sPageName, XPHashtable _htFormData) Calls the right save function according to the page name passed in argument.
void	SetDisableSecurity(boolean bDisableSecurity) Sets whether security should be disabled.

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

CheckEditorAccess, CheckEditorAccessAndStart, CheckFolderType, DisableSecurity, Finish, ForceSaveInFolder, GetClassID, GetFolderID, GetFolderName, GetIsSysAdmin, GetMigrationStatus, GetObject, GetObjectDescription, GetObjectID, GetObjectName, GetParentFolderPath, GetPTSession, Init, InitIsSysAdminFlag, InitPTObject, IsDescriptionDisabled, IsMigrationApproved, SaveMigrationStatus, SetDisableDescription, SetEditorToReadOnly, SetMemberVariablesFromQS, SetMigrationStatus, StartKeywords, StartLocNamesList, StartMigrationHistory, StartObjectProp, StartSecurityList, StoreObject

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

Cancel, CleanupAllData, CleanupTempData, DoTaskOnChangePage, GetAccessToEditorPriviledges, GetCloseOnDone, GetCurrentRepostAction, GetDeleteOnCancel, GetEditorType, GetEnableApplyButton, GetEnableCancelButton, GetHideLeftNav, GetIsEditorReadOnly, GetRedirectAfterFinish, GetUserHasAccessToEditor, SetCloseOnDone, SetDeleteOnCancel, SetEditorType, SetEnableApplyButton, SetHideLeftNav, SetPageStatus, SetUserHasAccessToEditor

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.editor.IObjEditorModelRO

GetClassID, GetObject, GetObjectDescription, GetObjectID, GetObjectName, GetParentFolderPath, GetPTSession

Methods inherited from interface com.plumtree.uiinfrastructure.editor.IEditorModelRO

GetEditorType, GetEnableApplyButton, GetEnableCancelButton, GetHideLeftNav, GetIsEditorReadOnly

Field Detail

STR_MVC_CLASS_NAME

public static final java.lang.String STR_MVC_CLASS_NAME

class name

See Also:

Constant Field Values

CLIENT_VALIDATION_MAX_NAME

public static final int CLIENT_VALIDATION_MAX_NAME

RWW - Constants for client side validation

See Also:

Constant Field Values

BR_ELEMENT

public static final java.lang.String BR_ELEMENT

See Also:

Constant Field Values

Constructor Detail

AdminFolderModel

public AdminFolderModel()

Method Detail

GetCurrentFolderACL

public IPTAccessList GetCurrentFolderACL()

Returns:

the current IPTAccessList of the folder whose security is being edited

IsAdminModifiedOnFolder

public boolean IsAdminModifiedOnFolder(IPTAccessList _ptOldACL)

Parameters:

_ptOldACL - the IPTAccessList from before the ACLs were changed

Returns:

true if an admin acl was added or an acl was changed to admin.

ABOJobIDToDisplay

public boolean ABOJobIDToDisplay()

Description copied from interface: IFolderSecurityABOModelRO

This method returns whether or not there is a job ID to display.

Specified by:

ABOJobIDToDisplay in interface IFolderSecurityABOModelRO

Returns:

boolean true implies there is a job ID to display.

See Also:

com.plumtree.portalpages.admin.editors.adminfolder.IAdminFolderModelRO#ABOJobIDToDisplay()

ApplySecurityChangesUsingABO

public void ApplySecurityChangesUsingABO(boolean bPropagateAllACLs)

Apply the subportal profile to the users in the folder later, using ABO.

Parameters:

bPropagateAllACLs - - If true propagate all acls to child objects and subfolders, if false propagate only admin acls.

Create

public java.lang.Object Create()

Description copied from class: EditorModel

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 EditorModel

Returns:

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

See Also:

IManagedObject.Create()

DoTaskAfterStore

public void DoTaskAfterStore()

Code executed after done is clicked, after object is saved.

Overrides:

DoTaskAfterStore in class EditorModel

DoTaskBeforeStore

public void DoTaskBeforeStore()

Code executed after done is clicked, before object is saved.

Overrides:

DoTaskBeforeStore in class EditorModel

DoTaskOnComeBackFromSubEditor

public void DoTaskOnComeBackFromSubEditor()

This method will be called when you come back to the main Editor from a sub Editor.

Overrides:

DoTaskOnComeBackFromSubEditor in class ObjEditorModel

DoTaskOnStartEditor

public void DoTaskOnStartEditor(XPHashtable _htFormData)

Initialize any settings here.

Overrides:

DoTaskOnStartEditor in class EditorModel

Parameters:

_htFormData -

GetABOJobID

public int GetABOJobID()

Description copied from interface: IFolderSecurityABOModelRO

This method returns the job ID for a security change job.

Specified by:

GetABOJobID in interface IFolderSecurityABOModelRO

Returns:

int the job ID for security changes.

See Also:

com.plumtree.portalpages.admin.editors.adminfolder.IAdminFolderModelRO#GetABOJobID()

GetEditObjectURL

public ASURL GetEditObjectURL(int _nClassID,
                              int _nObjectID)

Returns the URL to edit the object.

Specified by:

GetEditObjectURL in interface ISecurityMatrixModelRO

Parameters:

_nClassID -

_nObjectID -

_sEditorASName -

Returns:

ASURL URL to the Editor

GetName

public java.lang.String GetName()

Returns the Class name.

Specified by:

GetName in interface IMVCObject

Specified by:

GetName in class EditorModel

Returns:

String

GetNumSubPortals

public int GetNumSubPortals()

Returns the number of SubPortals that were loaded.

Specified by:

GetNumSubPortals in interface ISecurityMatrixModelRO

Returns:

int number of profiles

GetRegularFolderID

public java.lang.String GetRegularFolderID()

Returns the id of a regular folder.

Specified by:

GetRegularFolderID in interface ISecurityMatrixModelRO

Returns:

String ID of regular folder

GetSelectedSubPortalID

public java.lang.String GetSelectedSubPortalID()

Returns the id of the selected subportal.

Specified by:

GetSelectedSubPortalID in interface ISecurityMatrixModelRO

Returns:

String ID of selected subportal

GetSubPortalID

public java.lang.String GetSubPortalID(int pos)

Returns the id of the subportal at a given position. This is returned as a string because we only need to do html with the id.

Specified by:

GetSubPortalID in interface ISecurityMatrixModelRO

Returns:

String ID of subportal

GetSubPortalName

public java.lang.String GetSubPortalName(int pos)

Returns the name of the subportal at a given position.

Specified by:

GetSubPortalName in interface ISecurityMatrixModelRO

Returns:

String name of subportal

RaiseError

public void RaiseError(java.lang.String strError)

RepostAdvPage

public void RepostAdvPage()

Does nothing for now.

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

Overrides:

SavePage in class ObjEditorModel

Parameters:

_sPageName -

_htFormData -

Returns:

int Page status for server side validation

SetDisableSecurity

public void SetDisableSecurity(boolean bDisableSecurity)

Sets whether security should be disabled. .

SaveAdvPage

protected int SaveAdvPage(XPHashtable _htFormData)

Saves the data on the Advanced page.

Parameters:

_htFormData -

Returns:

int Page status for server side validation

GetCreatedJobName

public java.lang.String GetCreatedJobName()

Retrieves the name of the job created by ABO.

Specified by:

GetCreatedJobName in interface IFolderSecurityABOModelRO

GetFolderNameForCreatedJobs

public java.lang.String GetFolderNameForCreatedJobs()

Retrieves the name of the folder that ABO created the job in.

Specified by:

GetFolderNameForCreatedJobs in interface IFolderSecurityABOModelRO