Plumtree Portal UI  
 

ObjectSecurityModel Members

ObjectSecurityModel overview

Public Static Fields

EXPLIST_COL_ACCESSLEVEL_ID This column is used to store the access level ID of each row.
EXPLIST_COL_ACCESSLEVEL_STRING This column is used to store the access level String of each row.
EXPLIST_COL_GROUPTREEASID On each group on the list there is a link to get the tree of groups in the users in that group. This column is used the sotre the tree AS IDs.
EXPLIST_COL_MANDATORY If the Object being created or edited is mandatory for this user or group. Note: not use for all objects. Used for both mandatory column index for portlets and communities. CONSTRAINT: Cannot two of these mandatory cols in the same table for now.
EXPLIST_COL_MAX Number total of columns
EXPLIST_COL_ROWACCESS If the row is read only, we won't deisplay the checkbox to delete it.
EXPLIST_DEFAULT_INITIAL_SIZE Default initial size for the sorted array.
MANDATORY_FALSE Mandatory column value: the Object is NOT mandatory for this user of group
MANDATORY_TRUE Mandatory column value: the Object is mandatory for this user of group
MANDCOL_COMMUNITY Value for m_nSupportMandatoryColumn: community
MANDCOL_NONE Value for m_nSupportMandatoryColumn: none
MANDCOL_REGULAR Value for m_nSupportMandatoryColumn: regular
PT_ACCESS_LIST_ENTRY_READONLY Read only flag value for the EXPLIST_COL_ROWACCESS column. Read only means that the user won't be able to delete that row.
PT_ACCESS_LIST_ENTRY_READWRITE Read/Write flag value for the EXPLIST_COL_ROWACCESS column. Read/Write means that the user will be able to delete that row.
STR_MVC_CLASS_NAME Class name for the activity space
SUBSPACE_KEY_EVERYONETREE Key name used by the Activity Space to store the read-only everyone tree.
SUBSPACE_KEY_GROUPTREE Key name used by the Activity Space to store the read-only groups in groups tree.

Public Instance Constructors

ObjectSecurityModel Constructor Initializes a new instance of the ObjectSecurityModel class.

Public Instance Fields

m_asOwner (inherited from com.plumtree.uiinfrastructure.editor.EditorHelperModel) 
m_nNextIndex (inherited from com.plumtree.uiinfrastructure.expandablelist.ExpListModel) 

Public Instance Methods

AddACLFromTree This method adds the group and users selected in the tree to the list. It deletes the unselected values and adds the newly selected values. It doesn't change the values that were already in the list (this way we don't loose the rights information).
AddControlParamsToURL (inherited from SelectPTObjectModel) Helper function for extracting and adding extra control parameters from the create object string.
AddRowsOnRepost Calls the right AddRow method based on the Object type.
CanPropagateSecurity 
CleanupAllData (inherited from com.plumtree.uiinfrastructure.editor.EditorHelperModel) 
CleanupTempData (inherited from com.plumtree.uiinfrastructure.editor.EditorHelperModel) 
ClearHiddenObjects (inherited from SelectPTObjectModel) Clears the hidden objects for the tree.
ContainsObject (inherited from SelectPTObjectModel) Tells whether the Object identified by the class ID and the object ID in argument is in the list or no.
Create 
DeleteRowsOnRepost (inherited from com.plumtree.uiinfrastructure.expandablelist.ExpListModel) 
DisableAddButton (inherited from com.plumtree.uiinfrastructure.expandablelist.ExpListModel) 
DisableCheckBoxes (inherited from com.plumtree.uiinfrastructure.expandablelist.ExpListModel) 
DisplayGroupMembersTree Returns true if this group should have a link to view its members.
DoTaskOnComeBackFromSubEditor (inherited from SelectPTObjectModel) This method will be called when you come back to the main Editor from a sub Editor.
EnablePagination (inherited from com.plumtree.uiinfrastructure.expandablelist.ExpListModel) 
Equals (inherited from Object)Determines whether the specified Object is equal to the current Object.
Finish Saves the security settings into the IPTObject.
GetAccessLevel (inherited from SelectPTObjectModel) Returns the nAccessLevel. The accesslevel of the objects for the tree control to display.
GetAccessLevels Returns the array of supported Access Levels. Those levels will be printed out on each row in a drop-down list.
GetAccessLevelString Returns the String associated with the Access Level ID in argument. The ID has to be a PT_ACCESS_LEVELS constant.
GetAddIcon (inherited from com.plumtree.uiinfrastructure.expandablelist.ExpListModel) 
GetAddIconAlt (inherited from com.plumtree.uiinfrastructure.expandablelist.ExpListModel) 
GetAddLabel (inherited from com.plumtree.uiinfrastructure.expandablelist.ExpListModel) 
GetAlertMessageForEmptyList (inherited from com.plumtree.uiinfrastructure.expandablelist.ExpListModel) 
GetArrayOfObjToDelete (inherited from com.plumtree.uiinfrastructure.expandablelist.ExpListModel) 
GetArrExpListColInfo (inherited from com.plumtree.uiinfrastructure.expandablelist.ExpListModel) 
GetCommunityFolderID (inherited from SelectPTObjectModel) Returns the community id for the tree.
GetCommunityMode (inherited from SelectPTObjectModel) Returns the community mode for the tree.
GetCreateNewInfo (inherited from SelectPTObjectModel) Returns the create new action informations.
GetCreateNewURL (inherited from SelectPTObjectModel) Returns the URL to the Editor in create mode (new object).
GetCurrentLowerObjectCount (inherited from com.plumtree.uiinfrastructure.expandablelist.ExpListModel) 
GetCurrentUpperObjectCount (inherited from com.plumtree.uiinfrastructure.expandablelist.ExpListModel) 
GetDefaultRowIcon (inherited from SelectPTObjectModel) Returns the icon to display on each row before the input text. If the value is null, no icon is displayed.
GetDeleteIcon (inherited from com.plumtree.uiinfrastructure.expandablelist.ExpListModel) 
GetDeleteIconAlt (inherited from com.plumtree.uiinfrastructure.expandablelist.ExpListModel) 
GetDelRowConfirmMsg (inherited from com.plumtree.uiinfrastructure.expandablelist.ExpListModel) 
GetDisplayObjects (inherited from SelectPTObjectModel) Returns the array of objects to display in the tree.
GetEditObjectURL (inherited from SelectPTObjectModel) Returns the URL to edit the object.
GetEmptyListInstructions (inherited from com.plumtree.uiinfrastructure.expandablelist.ExpListModel) 
GetEmptyListMainMessage (inherited from com.plumtree.uiinfrastructure.expandablelist.ExpListModel) 
GetEnableMoveRowActions (inherited from com.plumtree.uiinfrastructure.expandablelist.ExpListModel) 
GetHashCode (inherited from Object)Serves as a hash function for a particular type. GetHashCode is suitable for use in hashing algorithms and data structures like a hash table.
GetHiddenObjects (inherited from SelectPTObjectModel) Returns the hidden objects for the tree.
GetIsCardACL Returns the value of m_bCardACL.
GetIsListReadOnly (inherited from com.plumtree.uiinfrastructure.expandablelist.ExpListModel) 
GetItems (inherited from com.plumtree.uiinfrastructure.expandablelist.ExpListModel) 
GetLeftNavString Returns the String to display on the left navigation menu.
GetListKey (inherited from com.plumtree.uiinfrastructure.expandablelist.ExpListModel) 
GetMainColumnSort (inherited from SelectPTObjectsByTypeModel) Returns the column ID of the primary sorted column. (the array can be sorted by multiple columns)
GetMainColumnSortDirection (inherited from SelectPTObjectsByTypeModel) Returns the sort direction of the primary sorted column.
GetModelStorageName (inherited from com.plumtree.uiinfrastructure.expandablelist.ExpListModel) 
GetName Returns the Class name.
GetNoRowIcons (inherited from SelectPTObjectModel) Returns the value of the m_bNoRowIcons member variable. True if no icons are to be displayed on each selected row.
GetNumObjects (inherited from com.plumtree.uiinfrastructure.expandablelist.ExpListModel) 
GetObjectClassIDs (inherited from SelectPTObjectModel) Returns String of Class ID of the Objects displayed in the tree. E.g.: "2,45,3" This is the format used by the tree.
GetPaginationSize (inherited from com.plumtree.uiinfrastructure.expandablelist.ExpListModel) 
GetReadOnlyItems (inherited from com.plumtree.uiinfrastructure.expandablelist.ExpListModel) 
GetRowIconByClassID (inherited from SelectPTObjectModel) Returns the icon to display on each row before the input text, given a class id. If the value is null then we get the default row icon.
GetSectionTitle (inherited from com.plumtree.uiinfrastructure.expandablelist.ExpListModel) 
GetSelectedItems Returns a String of Class IDs and Object IDs of the Objects to select in the tree. E.g.: "classID1,ObjID1,classID2,objID2" This is the format used by the tree.
GetSelectedNamesAsHTML (inherited from SelectPTObjectModel) Helper method to get a String with the selected Object names. E.g.: User1, User2, Group1 Will return an empty String if no Object was selected.
GetShowHeaderAndLeftNav Tells whether or not the DP should display the header and the left navigation.
GetSupportMandatoryColumn Returns the value of m_nSupportMandatoryColumn.
GetTableInstructions (inherited from com.plumtree.uiinfrastructure.expandablelist.ExpListModel) 
GetTreeLeafType (inherited from SelectPTObjectModel) Returns the leaf type of the tree.
GetTreeMultiSelect (inherited from SelectPTObjectModel) Returns the selection type of the tree. Converts the boolean value to a string so that it can be put in the query string for the tree.
GetTreeQueryFilter (inherited from SelectPTObjectModel) Returns the query filter for the tree.
GetTreeSpaceID (inherited from SelectPTObjectModel) Returns tree AS ID.
GetTreeSubTitle (inherited from SelectPTObjectModel) Returns the Tree sub title.
GetTreeTitle (inherited from SelectPTObjectModel) Returns the Tree title.
GetType (inherited from Object)Gets the Type of the current instance.
GetUniqueInt (inherited from com.plumtree.uiinfrastructure.expandablelist.ExpListModel) 
GetUniquePopUpName (inherited from SelectPTObjectModel) Returns a unique String for the name of the pop-up.
GetUniqueString (inherited from com.plumtree.uiinfrastructure.expandablelist.ExpListModel) 
GetUnusedProperties (inherited from com.plumtree.uiinfrastructure.expandablelist.ExpListModel) 
GetWrapColumnHeaders (inherited from com.plumtree.uiinfrastructure.expandablelist.ExpListModel) 
HasEditAccessToGroup Helper function that returns true if the current user has edit access on the group identified by the ID in argument.
HasSecurityChanged Returns a flag to know whether the security has changed compared to what we have in the DB or no.
Init (inherited from com.plumtree.uiinfrastructure.editor.EditorHelperModel) 
InitializeExpandableList (inherited from com.plumtree.uiinfrastructure.expandablelist.ExpListModel) 
InitializeListClassIDs (inherited from SelectPTObjectModel) Partialally initializes the expandable list. InitializeExpandableList must also be called when this method is used.
InitializeReadOnlyExpandableList (inherited from com.plumtree.uiinfrastructure.expandablelist.ExpListModel) 
InitializeReadOnlySelectPTObject (inherited from SelectPTObjectModel) Initializes the read only expandable list.
InitializeSecurityPage Initializes the expandable list.
InitializeSelectPTObject (inherited from SelectPTObjectModel) Initializes the expandable list.
InitializeSortedArray (inherited from SelectPTObjectsByTypeModel) Initalizes the list (PTGrowableSortedArrayWrapper) with a column mapping and an array of sort. The growable array will always be sorted by the 1st column ascending.
IsACLInArray Tells whether the Object ACL identified by the class ID, the object ID and the Access Level ID in argument is in the list or no.
IsAddButtonDisabled (inherited from com.plumtree.uiinfrastructure.expandablelist.ExpListModel) 
IsCheckBoxesDisabled (inherited from com.plumtree.uiinfrastructure.expandablelist.ExpListModel) 
IsEditLinkEnabled (inherited from SelectPTObjectModel) Returns true if it should be possible to edit Objects from this class ID.
IsEveryoneGroup Returns true if the object on the row in argument corresponds to the Everyone Group.
IsObjectReadOnly (inherited from SelectPTObjectModel) Returns true if the object identified by the class id and the object id in argument is read only.
IsPaginationEnabled (inherited from com.plumtree.uiinfrastructure.expandablelist.ExpListModel) 
ModifyRow (inherited from com.plumtree.uiinfrastructure.expandablelist.ExpListModel) 
MoveRow (inherited from com.plumtree.uiinfrastructure.expandablelist.ExpListModel) 
ResetTreeID (inherited from SelectPTObjectModel) Resets the tree ID, this way a new tree will be opened. This can be used to switch from a multi select tree to a single select tree for example.
ReverseCurrentSort (inherited from SelectPTObjectsByTypeModel) Reverses the sort of all the sorted columns.
SaveSection (inherited from com.plumtree.uiinfrastructure.expandablelist.ExpListModel) 
SetAccessLevel (inherited from SelectPTObjectModel) Sets the nAccessLevel. The accesslevel of the objects for the tree control to display.
SetAddIcon (inherited from com.plumtree.uiinfrastructure.expandablelist.ExpListModel) 
SetAddIconAlt (inherited from com.plumtree.uiinfrastructure.expandablelist.ExpListModel) 
SetCardACL Special case for Crawler Editor where it's possible to Edit the ACL for cards imported by this crawler.
SetCommunityFolderID (inherited from SelectPTObjectModel) Sets the community folder id for the tree. By default there is no community folder id.
SetCommunityMode (inherited from SelectPTObjectModel) Sets the community mode for the tree. By default there is no community mode.
SetDefaultObjects (inherited from SelectPTObjectModel) Add the array passed in argument to the list. The array should be created using the EXPLIST_COL constants defined in this class.
SetDefaultRowIcon (inherited from SelectPTObjectModel) Sets the icon to display on each row before the input text. By default, no icon is displayed.
SetDeleteIcon (inherited from com.plumtree.uiinfrastructure.expandablelist.ExpListModel) 
SetDeleteIconAlt (inherited from com.plumtree.uiinfrastructure.expandablelist.ExpListModel) 
SetDelRowConfirmMsg (inherited from com.plumtree.uiinfrastructure.expandablelist.ExpListModel) 
SetDisplayObjects (inherited from SelectPTObjectModel) Sets the array of objects to display in the tree. (Only those objects will be display in the tree.) The array in argument should be in the following format: classid1,objectid1,classid2,objectid2....
SetEmptyListMessages (inherited from com.plumtree.uiinfrastructure.expandablelist.ExpListModel) 
SetEnableCreateNew (inherited from SelectPTObjectModel) Enables the create new links for the Class ID in argument. Doing this will also enbale the links to Edit the Objects in the list.
SetEnableEmptyListClientValidation (inherited from com.plumtree.uiinfrastructure.expandablelist.ExpListModel) 
SetEnableMoveRowActions (inherited from SelectPTObjectModel) Because this select ptobject list needs to support both move row actions enable and disable, we need to change the colspan of the header row when this happens.
SetHiddenObjects (inherited from SelectPTObjectModel) Sets the hidden objects for the tree. By default there are no hidden objects.
SetIsListReadOnly (inherited from com.plumtree.uiinfrastructure.expandablelist.ExpListModel) 
SetLeftNavString Sets the String to display on the left navigation menu.
SetListKey (inherited from com.plumtree.uiinfrastructure.expandablelist.ExpListModel) 
SetNoRowIcons (inherited from SelectPTObjectModel) Sets the m_bNoRowIcons member variable. True if no icons are to be displayed on each selected row.
SetPagination (inherited from com.plumtree.uiinfrastructure.expandablelist.ExpListModel) 
SetReadOnlyObjects (inherited from SelectPTObjectModel) Sets the read only objects. Those object won't appear in the tree and the user will not be able to delete them.
SetRowIconByClassID (inherited from SelectPTObjectModel) Sets the icon to display on each row before the input text, given a class id. By default, all class ids are associated with empty images. Call SetDefaultRowIcon to set a universal default icon.
SetSectionTitle (inherited from com.plumtree.uiinfrastructure.expandablelist.ExpListModel) 
SetShowHeaderAndLeftNav Changes the value of the flag m_bShowHeaderAndLeftNav that decides if the DP should display the header and the left navigation.
SetSupportMandatoryColumn Sets a new value for m_nSupportMandatoryColumn.
SetTableInstructions (inherited from com.plumtree.uiinfrastructure.expandablelist.ExpListModel) 
SetTreeLeafType (inherited from SelectPTObjectModel) Sets the leaf type for the tree. Is set to N_LEAFSELECT by default.
SetTreeMultiSelect (inherited from SelectPTObjectModel) Sets the selection type for the tree. Multiselect is set to true by default.
SetTreeQueryFilter (inherited from SelectPTObjectModel) Sets the query filter for the tree. By default there is no query filter.
SetTreeSubTitle (inherited from SelectPTObjectModel) Sets the Tree sub title.
SetTreeTitle (inherited from SelectPTObjectModel) Sets the Tree title.
SetWrapColumnHeaders (inherited from com.plumtree.uiinfrastructure.expandablelist.ExpListModel) 
SortByColumn (inherited from SelectPTObjectsByTypeModel) Gets the column ID back from the form data and resort the array by that column ID, ascending.
ToString (inherited from Object)Returns a String that represents the current Object.

Protected Instance Fields

m_arrAccessLevels Array of supported Access Levels (constants from PT_ACCESS_LEVELS).
m_arrCreateNewInfo (inherited from SelectPTObjectModel) Information about the create new links to display
m_arrExpListColInfo (inherited from com.plumtree.uiinfrastructure.expandablelist.ExpListModel) 
m_arrLowAccessObjects Special case for ACLs that the current user doesn't have at least select access to. These ACLs can be removed but not re-added.
m_arrNoContentTree You can click on a group only if the current user has at least read access to it.
m_arrObjectClassIDs (inherited from SelectPTObjectModel) Class ID of the Objects displayed on the list.
m_arrReadOnlyObjects (inherited from SelectPTObjectModel) JF- Array of classID/objectID that cannot be deleted from the list.
m_bAddButtonDisabled (inherited from com.plumtree.uiinfrastructure.expandablelist.ExpListModel) 
m_bCardACL Special case for Crawler Editor where it's possible to Edit the imported cards ACL.
m_bCheckBoxesDisabled (inherited from com.plumtree.uiinfrastructure.expandablelist.ExpListModel) 
m_bEnableMoveRowActions (inherited from com.plumtree.uiinfrastructure.expandablelist.ExpListModel) 
m_bIsReadOnly (inherited from com.plumtree.uiinfrastructure.expandablelist.ExpListModel) 
m_bNoRowIcons (inherited from SelectPTObjectModel) JH: Set to true if no row icons are to be displayed. This will override m_xphtRowIcons, m_imgDefaultRowIcon, and the default ClassDescriptor icon retrieval mechanism.
m_bShowHeaderAndLeftNav We don't want to display the header and the left navigation in create mode when the Security table is displayed in the save object pop-up.
m_bTreeMultiSelect (inherited from SelectPTObjectModel) Selection type for the object tree.
m_bWrapColumnHeaders (inherited from com.plumtree.uiinfrastructure.expandablelist.ExpListModel) 
m_imgAddIcon (inherited from com.plumtree.uiinfrastructure.expandablelist.ExpListModel) 
m_imgDefaultRowIcon (inherited from SelectPTObjectModel) Icon to display on each row, just before the input text. RWW: This will now be the "default". See m_xphtRowIcons for precedence in icon loading.
m_imgDeleteIcon (inherited from com.plumtree.uiinfrastructure.expandablelist.ExpListModel) 
m_nAccessLevel (inherited from SelectPTObjectModel) This value determines the security access requirements for the objects to be added to the list... (a filter for the tree control).
m_nCommunityFolderID (inherited from SelectPTObjectModel) Community Folder ID to display objects from.
m_nCommunityMode (inherited from SelectPTObjectModel) Community Mode to display objects.
m_nListKey (inherited from com.plumtree.uiinfrastructure.expandablelist.ExpListModel) 
m_nSupportMandatoryColumn Flag to know if we should display the mandatory column for this Object.
m_ptObject Object being created or edited. We use it on start to prepopulate the list and on finish to store the ACL.
m_ptSession Current User Session
m_saData (inherited from com.plumtree.uiinfrastructure.expandablelist.ExpListModel) 
m_sAddIconAlt (inherited from com.plumtree.uiinfrastructure.expandablelist.ExpListModel) 
m_sAddLabel (inherited from com.plumtree.uiinfrastructure.expandablelist.ExpListModel) 
m_sDeleteIconAlt (inherited from com.plumtree.uiinfrastructure.expandablelist.ExpListModel) 
m_sDelRowConfirmMsg (inherited from com.plumtree.uiinfrastructure.expandablelist.ExpListModel) 
m_sDisplayObjects (inherited from SelectPTObjectModel) Class IDs and Object IDs of objects to display in the tree.
m_sEmptyListAlert (inherited from com.plumtree.uiinfrastructure.expandablelist.ExpListModel) 
m_sInstructions (inherited from com.plumtree.uiinfrastructure.expandablelist.ExpListModel) 
m_sLeftNavString String to display on the left navigation menu. The default value is "Security"
m_sMainMessage (inherited from com.plumtree.uiinfrastructure.expandablelist.ExpListModel) 
m_sSectionTitle (inherited from com.plumtree.uiinfrastructure.expandablelist.ExpListModel) 
m_sTableInstructions (inherited from com.plumtree.uiinfrastructure.expandablelist.ExpListModel) 
m_sTreeSpaceID (inherited from SelectPTObjectModel) Tree Space ID. The first time the ID is empty and a new AS is opened, but after that, we save the ID and the same tree AS is reopened each time.
m_sTreeSubTitle (inherited from SelectPTObjectModel) Tree sub title
m_sTreeTitle (inherited from SelectPTObjectModel) Tree title
m_strObjectsToHide (inherited from SelectPTObjectModel) Objects to hide for the object tree.
m_strTreeQueryFilter (inherited from SelectPTObjectModel) Query Filter for the object tree.
m_treeLeafType (inherited from SelectPTObjectModel) Leaf type for the object tree.
m_xphtRowIcons (inherited from SelectPTObjectModel) RWW: Stores multiple icons - allows us to store a different icon for each class id. When retrieving icons internally, this table will be checked first. If no icons appear here, then we will check the default row icon. If that is null, then we will show no image. Having an icon for a specific class id in this table will take precedence.
parent (inherited from com.plumtree.uiinfrastructure.expandablelist.ExpListModel) 

Protected Instance Methods

AddACLToList Helper method that adds a row to the list. NOTE: Items added to the growable sorted list is not resorted after adding an entry due to scalability reasons. Resort the growable sort array manually by calling: super.GetItems().SortArray()
CreateIndexMapping (inherited from SelectPTObjectModel) Helper method to create a temporary array of index mapping. On each row we have the following info: class ID - Object ID - index This method is used to not loose the order when the move row actions are enabled.
Finalize (inherited from Object)Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
GetArrayOfColumns Helper method to get the sort.
GetColumnInfos Helper method to get the array of column info.
GetIndex (inherited from SelectPTObjectModel) Helper method to get the value of the index for the object identified by the object ID and class ID in argument. Returns -1 if the object was not in the array.
GetMoveAction (inherited from com.plumtree.uiinfrastructure.expandablelist.ExpListModel) 
GetRowIndex (inherited from com.plumtree.uiinfrastructure.expandablelist.ExpListModel) 
HasAccessRights Helper method to know whether or not the current user has at least select access to the object in argument.
InitAccessLevels Inits the array of supported Access Levels.
InitListWithACLFromObject Initializes the list with the ACL from the PTObject.
InitReadOnlyAccessFlag Initializes the m_bIsReadOnly flag to know if the user can edit the page or not. Only users with admin access on the object can edit this page.
MemberwiseClone (inherited from Object)Creates a shallow copy of the current Object.
MoveDown (inherited from com.plumtree.uiinfrastructure.expandablelist.ExpListModel) 
MoveFirst (inherited from com.plumtree.uiinfrastructure.expandablelist.ExpListModel) 
MoveLast (inherited from com.plumtree.uiinfrastructure.expandablelist.ExpListModel) 
MoveUp (inherited from com.plumtree.uiinfrastructure.expandablelist.ExpListModel) 
SaveRow Saves the access level for the row _nRowIndex.
SaveTreeID (inherited from SelectPTObjectModel) Helper method to save the Tree ID on repost.

See Also

ObjectSecurityModel Class | com.plumtree.portaluiinfrastructure.editor.commonpages.objectsecurity Namespace