class %CSP.UI.SQL.UserPrivPane
extends %CSP.Util.Pane, %CSP.UI.SQL.Error, %CSP.UI.SQL.USER
This class is used internally by Caché. You should not make direct use of it within your applications. There is no guarantee made about either the behavior or future operation of this class.
This pane allows user to modify privileges of all kinds.
• parameter DOMAIN = "%Utility";
Default domain for the Portal's localization.
• parameter TitleGrant = "click to change privilege";
• parameter cellValue1 = "º";
• parameter cellValue2 = "•";
• parameter cellValue3 = "-";
• parameter sBase = ",,,,,,,,,,,,,,,,,,,,,,,";
Base value for saving privileges
• parameter sPrivileges = "%ALTER,SELECT,INSERT,UPDATE,DELETE,REFERENCES";
• property ISREADONLY
as %Boolean [ InitialExpression = $$$SMPIsReadOnly($$$EMSRolesBit) ];
• classmethod BuildLine(id As %String, tLastName As %String, tVal As %String, TableType As %String, nPrivilegesLen As %Integer)
Used by LoadObject to build controls for granting/voking privileges for this table/view.
• method DrawBODY(pInstance As PageInstance)
as %Status
Overwritten by subclasses to draw anything this pane needs for the BODY section.
• method DrawCommands(pInstance As PageInstance)
as %Status
Generic method to draw commands for a pane;
A subclass can override this.
• method DrawHEAD(pInstance As PageInstance)
as %Status
Special style for displaying user privilege info on this page
• classmethod DrawNamespaces(NAMESPACE, IncludeSystem="")
as %String
Draw Namespace drop-down box.
This method is called by several tabs. If IncludeSystem is included it means that
tab needs to show the Include System checkbox (and IncludeSystem indicates whether the
checkbox should be checked or not. Otherwise don't include the second parameter in that case
it is "" and the checkbox won't be shown.
• classmethod DrawTab(ByRef tID As %String, tab As %Integer, sType As %String)
• classmethod DrawTabBox(menuHd As %String, ByRef tID As %String, ByRef tab As %String, t As %Integer, pagename As %String)
Draws unselected tab
• classmethod GetConfirmMessage(tRow)
Return confirmation message based on row number. This is done to avoid js error when name contains "'".
• classmethod GetNames(Type As %String = "Users", ByRef AllNames As %String, ShowUserRole As %Integer)
as %Integer
Get all Roles or Users names
• classmethod GetRowName(tRow)
Return user or role "Members" name based on row number. This is done to avoid js error when name contains "'".
• classmethod LoadObject(NAMESPACE As %String, ByRef tID As %String, Type As %String, tab As %Integer, IncludeSystem As %Boolean)
• classmethod LoadPriv(NAMESPACE As %String, ByRef tID As %String, ISREADONLY As %Boolean)
Load system privileges for this user.
• classmethod LoadRole(ByRef tID As %String, Type As %String, ByRef savemsg As %String, sType As %String, ISREADONLY As %Boolean)
• classmethod LoadUserRole(ByRef tID As %String, Type As %String, ByRef savemsg As %String, sType As %String, ISREADONLY As %Boolean)
• classmethod LocalizeArray(ByRef LBLMSG As %String)
Common method to build localized array for labels and text that will be shown on this page.
• classmethod PerformGrant(sName As %Library.String, Privs As %String, nSys As %Integer)
Perform Grant or Revoke for one system privilege
Javascription function passes in sID which is in the format of
"Priv"RowNumber_nSYS
e.g. Priv1_0 is %ALTER_USER, nRow=1, nSys = 0 (Regular grant)
Priv2_2 is %CREATE_ROLE, nRow=2, nSys = 2 (Revoke)
Because Cache does string passing faster than JavaScript,
we do the parsing here.
nSys = 0 Grant regular privilege
nSys = 1 Grant System Adm Privilege
nSys = 2 Revoke
nRow represent the particular privilege that is built into msPriv array.
• classmethod PerformGrantAll(Namespace As %String, sName As %String, Privs As %String, nSys As %Integer)
as %String
Perform Grant or Revoke for ALL system privilege
Javascription function passes nSys
nSys = 0 Grant regular privilege
nSys = 1 Grant System Adm Privilege
nSys = 2 Revoke
Privs = a list of bit that is selected delimited by commas, e.g. 2,4
• classmethod PerformUserRole(userlist As %String, rolelist As %String, sType As %String, IsRevoke As %Integer, grantOption As %Integer = 0)
as %String
Perform Grant or Revoke for one user or role (in case user selected roles or memebers that's longer
than 32K, we break them into 100 items a piece before sending to the server to avoid error)
nSys = 1 Grant System Adm Privilege
nSys = 2 Revoke
nRow represent the particular privilege that is built into msPriv array.
sType = "Users" for assigning Role to User or Role
sType = "Roles" for assigning User to Role
• classmethod RevokeRow(NAMESPACE, Grantee, cbState, sActs, tab, sType, GrantedBy)
Prepare for granting or revoking by rows user checked.
• method SaveUserRole(tID As %String, sType As %String, savemsg As %String)
Method to save users or roles granted on the Members tab and the Assigned To tab.
