Class Reference
IRIS for UNIX 2024.1.2
InterSystems: The power behind what matters   
Documentation  Search
  [USER] >  [%CSP] >  [UI] >  [Component] >  [UserRoles]
Private  Storage   

class %CSP.UI.Component.UserRoles extends %CSP.UI.Component.abstractRoleTab

Component for editing roles on the User edit page

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
6


Summary

Properties
%condition %import %includeFiles %page
%resource PID align aux
avaList composite containerStyle dragEnabled
dropEnabled enclosingClass enclosingStyle error
height hidden hint hintClass
hintStyle id index label
labelClass labelDisabledClass labelStyle name
onafterdrag onbeforedrag ondrag ondrop
onhide onrefresh onshow onupdate
parent readOnly selList showLabel
slice title tuple type
valign visible width window

Methods
%AddToSaveSet %Attr %BindExport %ClassIsLatestVersion
%ClassName %ConstructClone %DispatchClassMethod %DispatchGetModified
%DispatchGetProperty %DispatchMethod %DispatchSetModified %DispatchSetMultidimProperty
%DispatchSetProperty %DrawComponentHTML %DrawHTML %DrawJSStrings
%EnclosingDivId %Eval %EvalC %Extends
%ForceClientRender %GetEventHandlers %GetParameter %GetXMLName
%IsA %IsModified %MakeId %New
%NormalizeObject %ObjectModified %OnAddToPageAfter %OnAddToPageBefore
%OnDrawEnclosingDiv %OnDrawObjectProperties %OnObjectSynch %OnZENDeserialize
%OriginalNamespace %PackageName %QuoteValue %QuoteValueL10N
%RemoveFromSaveSet %Self %SerializeObject %SetModified
%ValidateObject AssignRoles DrawArrows DrawArrowsOld
DrawAvailableList DrawSelectBoxes DrawSelectList DrawUpArrowsOld
RemoveAllRoles RemoveRole XMLDTD XMLExport
XMLExportToStream XMLExportToString XMLNew XMLSchema
XMLSchemaNamespace XMLSchemaType clearList doAssignRole
doChangeGrantOption doRemoveAllRoles doRemoveRole doSelectBoxMove
doSelectBoxMoveAll doSelectBoxMoveItem doSelectBoxMoveList dragFinishHandler
dragHandler dragNotifyHandler dragStartHandler dropHandler
dropStartHandler exposeComponent findElement fireOnUpdateEvent
getEnclosingDiv getHidden getHintElement getLabelElement
getProperty getSelList getSettings getType
invokeSuper isOfType makeId onCreate
onDelete onDisplayHandler onEndModalHandler onPopupAction
onRefreshContents onSerialize onStartModalHandler onloadHandler
onunloadHandler onupdateHandler refreshContents render
renderContents renderSVG setHidden setOverlayMode
setProperty startProgressBar stopProgressBar


Methods

• method %DrawHTML()
The %DrawHTML method draws the initial HTML for this component.
• method AssignRoles(PID As %String, RoleList As %String, GrantOption As %Boolean, Type As %String) as %String [ ZenMethod ]
Assign a Role to a User or change the grant option on a User's existing Role PID: User name RoleList: Comma-delimited list of roles to change In case user selected roles longer than 32K, we break them into 100 items a piece before sending to the server to avoid error GrantOption: 1 - Add grant option, 0 - Remove grant option
• method RemoveAllRoles(PID As %String, Type As %String) as %String [ ZenMethod ]
Remove all roles from a user Create a comma-delimited list of the user's roles and send it to RemoveRole()
• method RemoveRole(PID As %String, RoleList As %String, Type As %String) as %String [ ZenMethod ]
Remove a Role from a User PID: User name RoleList: Comma-delimited list of roles to remove In case user selected roles longer than 32K, we break them into 100 items a piece before sending to the server to avoid error
• method doAssignRole(type, grantOption) [ Language = javascript ]
• method doChangeGrantOption(roleID, isChecked) [ Language = javascript ]


Copyright (c) 2025 by InterSystems Corporation. Cambridge, Massachusetts, U.S.A. All rights reserved. Confidential property of InterSystems Corporation.