com.plumtree.portaluiinfrastructure.securitymatrix
Class SecurityMatrixModel

java.lang.Object
  extended by com.plumtree.uiinfrastructure.editor.EditorModel
      extended by com.plumtree.portaluiinfrastructure.securitymatrix.SecurityMatrixModel
All Implemented Interfaces:
IObjEditorModelRO, IFolderSecurityABOModelRO, ISecurityMatrixModelRO, IManagedObject, IModel, IModelRO, IMVCObject, IEditorModelRO, IRepostModel

public class SecurityMatrixModel
extends EditorModel
implements ISecurityMatrixModelRO

This class keeps an up-to-date state of all the settings. This class is used by the Section and by the Repost Control.

Author:
Julie Fournier

Field Summary
static java.lang.String BR_ELEMENT
           
static java.lang.String STR_MVC_CLASS_NAME
          Class name for the activity space
 
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
SecurityMatrixModel()
           
 
Method Summary
 boolean ABOJobIDToDisplay()
          This method returns whether or not there is a job ID to display.
 boolean CheckEditorAccessAndStart(XPHashtable _htFormData)
          Implements some actions to perform on start.
 java.lang.Object Create()
          This method is used by the ASManager to return new instances of managed objects.
 void Finish()
          Implement some code to execute when the user clicks on "Finish".
 int GetABOJobID()
          Retrieves the id of the job created by ABO.
 int GetClassID()
           
 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.
 IPTObject GetObject()
           
 java.lang.String GetObjectDescription()
           
 int GetObjectID()
           
 java.lang.String GetObjectName()
           
 java.lang.String GetParentFolderPath()
           
 IPTSession GetPTSession()
           
 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 PropagateSecurityUsingABO(boolean bPropagateAllACLs)
          Creates a job to propagate security.
 void RaiseError(java.lang.String strError)
           
 int SavePage(java.lang.String _sPageName, XPHashtable _htFormData)
          Calls the right save function according to the page name passed in argument.
 
Methods inherited from class com.plumtree.uiinfrastructure.editor.EditorModel
Cancel, CleanupAllData, CleanupTempData, DoTaskAfterStore, DoTaskBeforeStore, DoTaskOnChangePage, DoTaskOnComeBackFromSubEditor, DoTaskOnStartEditor, GetAccessToEditorPriviledges, GetCloseOnDone, GetCurrentRepostAction, GetDeleteOnCancel, GetEditorType, GetEnableApplyButton, GetEnableCancelButton, GetHideLeftNav, GetIsEditorReadOnly, GetRedirectAfterFinish, GetUserHasAccessToEditor, Init, 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.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 for the activity space

See Also:
Constant Field Values

BR_ELEMENT

public static final java.lang.String BR_ELEMENT
See Also:
Constant Field Values
Constructor Detail

SecurityMatrixModel

public SecurityMatrixModel()
Method Detail

CheckEditorAccessAndStart

public boolean CheckEditorAccessAndStart(XPHashtable _htFormData)
Implements some actions to perform on start.

Specified by:
CheckEditorAccessAndStart in class EditorModel
Parameters:
_htFormData -
Returns:
boolean Is true if the current user has the rights to access this Editor.

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

Finish

public void Finish()
Implement some code to execute when the user clicks on "Finish".

Specified by:
Finish in interface IRepostModel
Specified by:
Finish in class EditorModel

GetName

public java.lang.String GetName()
Returns the Class name.

Specified by:
GetName in interface IMVCObject
Specified by:
GetName in class EditorModel
Returns:
String

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
Specified by:
SavePage in class EditorModel
Parameters:
_sPageName -
_htFormData -
Returns:
int Page status for server side validation

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 ACL was changed
Returns:
true, if an admin acl was added or an acl was changed to admin.

PropagateSecurityUsingABO

public void PropagateSecurityUsingABO(boolean bPropagateAllACLs)
Creates a job to propagate security.

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

GetABOJobID

public int GetABOJobID()
Retrieves the id of the job created by ABO.

Specified by:
GetABOJobID in interface IFolderSecurityABOModelRO
Returns:
int the job ID for security changes.

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

RaiseError

public void RaiseError(java.lang.String strError)

GetClassID

public int GetClassID()
Specified by:
GetClassID in interface IObjEditorModelRO
See Also:
ObjEditorModel.GetClassID()

GetObject

public IPTObject GetObject()
Specified by:
GetObject in interface IObjEditorModelRO
See Also:
ObjEditorModel.GetObject()

GetObjectDescription

public java.lang.String GetObjectDescription()
Specified by:
GetObjectDescription in interface IObjEditorModelRO
See Also:
ObjEditorModel.GetObjectDescription()

GetObjectID

public int GetObjectID()
Specified by:
GetObjectID in interface IObjEditorModelRO
See Also:
ObjEditorModel.GetObjectID()

GetObjectName

public java.lang.String GetObjectName()
Specified by:
GetObjectName in interface IObjEditorModelRO
See Also:
ObjEditorModel.GetObjectName()

GetParentFolderPath

public java.lang.String GetParentFolderPath()
Specified by:
GetParentFolderPath in interface IObjEditorModelRO
See Also:
ObjEditorModel.GetParentFolderPath()

GetPTSession

public IPTSession GetPTSession()
Specified by:
GetPTSession in interface IObjEditorModelRO
See Also:
ObjEditorModel.GetPTSession()

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.

GetEditObjectURL

public ASURL GetEditObjectURL(int _nClassID,
                              int _nObjectID)
Description copied from interface: ISecurityMatrixModelRO
Returns the URL to edit the object.

Specified by:
GetEditObjectURL in interface ISecurityMatrixModelRO
Returns:
ASURL URL to the Editor

GetNumSubPortals

public int GetNumSubPortals()
Description copied from interface: ISecurityMatrixModelRO
Returns the number of SubPortals that were loaded.

Specified by:
GetNumSubPortals in interface ISecurityMatrixModelRO
Returns:
int number of SubPortals

GetRegularFolderID

public java.lang.String GetRegularFolderID()
Description copied from interface: ISecurityMatrixModelRO
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()
Description copied from interface: ISecurityMatrixModelRO
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)
Description copied from interface: ISecurityMatrixModelRO
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)
Description copied from interface: ISecurityMatrixModelRO
Returns the name of the SubPortal at a given position.

Specified by:
GetSubPortalName in interface ISecurityMatrixModelRO
Returns:
String name of SubPortal



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