Home > Class Reference > ENSLIB namespace > %CSP.UI.Portal.Roles
Private  Storage   

%CSP.UI.Portal.Roles


class %CSP.UI.Portal.Roles extends %CSP.UI.Portal.Utils

System Management Portal - Security Management - Roles

Inventory


Parameters Properties Methods Queries Indices ForeignKeys Triggers
6 1 9


Summary


This is a Zen Page class. It belongs to the application %CSP.UI.Portal.Application.

Properties
%condition %import %includeFiles %page
%resource CurrentColumn CurrentSort Filter
FirstFailed HelpAddress ISREADONLY InvalidParam
IsEMSReadOnly IsEditForm LocatorHeader OnclickArray
PID ParentURL StdTitle TableMaxRows
TablePageSize ValidationErrorMsg aboutPage align
aux backgroundTimerInterval captionLastUpdate cellAlign
cellSize cellStyle cellVAlign children
colDelete composite contactPage containerStyle
cssLevel currSortMode currStep currViewMode
disabled dragAndDrop dragEnabled dropEnabled
enableAutoRefresh enclosingClass enclosingStyle error
groupClass groupStyle height hidden
hint hintClass hintStyle home
homePage id index label
labelClass labelDisabledClass labelPosition labelStyle
layout lblTitle limitPopups name
onafterdrag onbeforedrag onclick ondrag
ondrop onhide onrefresh onshow
onupdate pageModified parent searchKey
showLabel slice title tuple
useSVG useSoftModals valign visible
width window zenPersistentPopup

Methods
%AddChild %AddChildAfter %AddChildBefore %AddComponent
%AddImportedComponents %AddLocatorLinks %AddToSaveSet %ApplyURLParms
%Attr %BindExport %ClassIsLatestVersion %ClassName
%ConstructClone %DispatchClassMethod %DispatchGetModified %DispatchGetProperty
%DispatchMethod %DispatchSetModified %DispatchSetMultidimProperty %DispatchSetProperty
%DrawAutoLogout %DrawClassDefinitions %DrawComponentHTML %DrawHTML
%DrawHTMLPage %DrawJSStrings %DrawObjectDefinitions %EnclosingDivId
%EndBackgroundMethod %EndScript %Eval %EvalC
%Extends %ForceClientRender %GetChildIndex %GetComponent
%GetComponentById %GetComponentByName %GetEventHandlers %GetHomePage
%GetHomeParam %GetLinks %GetLocatorLinks %GetNavTableState
%GetPageName %GetParameter %GetProductName %GetValueById
%GetValueByName %GetXMLName %IsA %IsModified
%Link %LinkCSS %LinkScript %MakeId
%New %NormalizeObject %ObjectModified %OnAddToPageAfter
%OnAddToPageBefore %OnAfterCreatePage %OnBeforeCreatePage %OnCreateApplication
%OnCreatePage %OnDetermineCSSLevel %OnDrawEnclosingDiv %OnDrawHTMLBody
%OnDrawHTMLHead %OnDrawHTMLMeta %OnDrawObjectProperties %OnFinishBackgroundTask
%OnGetPageName %OnGetProductName %OnGetSmallMenu %OnGetTitle
%OnMonitorBackgroundTask %OnMutateChildren %OnObjectSynch %OnPreHTTP
%OnSubmit %OnUseSoftModals %OnZENDeserialize %OriginalNamespace
%PackageName %QuoteValue %QuoteValueL10N %Register
%RemoveChild %RemoveChildren %RemoveComponent %RemoveFromSaveSet
%RunBackgroundMethod %Self %SerializeObject %SetBackgroundMethodStatus
%SetErrorById %SetErrorByName %SetModified %SetValueById
%SetValueByName %SetValuesByName %StartScript %ValidateObject
%ZENVersion BuildMenu BuildMeter CheckAllBlanks
CheckContextLinks CheckEnterpriseManager ConvertParameter Decrypt
Delete DoLogout DrawAutoRefresh DrawLocator
DrawRibbon DrawTitle Encrypt EscapeHTML
EscapeURL EvalResult GetCSPURL GetContextLinks
GetDocURL GetHomePage GetNewURL GetQuickLinks
HyperEventCall HyperEventHead Include InsertHiddenField
InsertHiddenFields IsPrivate LastUpdateTime Link
OnDrawRibbon OnGetRibbonInfo OnHTTPHeader OnPage
OnPageError OnPostHTTP OnPostHyperEvent OnPreHTTP
OnPreHyperEvent Page QuoteJS RegisterRecent
RewriteURL ShowError StartTimer StopTimer
ThrowError UnescapeHTML UnescapeURL UpdateAutoRefreshRate
UpdateAutoRefreshState UpdateTableNavState UpdateTableState XMLDTD
XMLExport XMLExportToStream XMLExportToString XMLNew
XMLSchema XMLSchemaNamespace XMLSchemaType addChild
addChildAfter addChildBefore afterSave afterValidate
cancelPopup changePassword childrenMutated columnSort
correctIELayering createComponent createComponentNS deleteComponent
disableCommandButton doCancel doDelete doEdit
doModified dragFinishHandler dragHandler dragNotifyHandler
dragStartHandler dropHandler dropStartHandler enableCommandButton
endModal exposeComponent filterChanged findElement
fireOnResizeEvent fireOnUnloadEvent fireOnUpdateEvent firePopupAction
getChildIndex getComponent getComponentById getEnclosingDiv
getHidden getHintElement getLabelElement getOpener
getPageTitle getProperty getSettings getTime
getTitleAreaHeight getType goHome goMenu
gotoNamespace gotoPage hideCommandButton invokeSuper
isButtonDisabled isOfType launchPopupWindow logout
makeId navMaxRowsChanged navPageSizeChanged navigate
onCreate onDelete onDisplayHandler onEndModalHandler
onPopupAction onRefreshContents onSerialize onServerMethodCall
onServerMethodError onServerMethodReturn onStartModalHandler ondisabledHandler
onkeydownHandler onkeyupHandler onlayoutHandler onloadHandler
onlogoutHandler onoverlayHandler onresizeHandler onunloadHandler
onupdateHandler popupActionHandler refreshContents refreshHandler
refreshkeyUp removeChild render renderContents
renderSVG resetMsg searchBlur searchBoxHandler
searchFocus searchKeyDown searchKeyPress setComponentId
setConnectivityStatusMsg setHidden setModified setOverlayMode
setPageTitle setProperty setPropertyAll setRefreshMode
setRefreshRate setSortMode setSortModeHandler setTraceOption
setViewMode setViewModeHandler showAbout showCommandButton
showContact showDocumentation showHelp showMsg
startModal startProgressBar stopProgressBar switchNamespace
trimSpace updateTime updateView validateRequired
zeroFill


Parameters


• parameter AUTONS = 0;
Do not switch namespace for this page: it needs to stay in %SYS
• parameter CSPURL = "/csp/sys/sec/%CSP.UI.Portal.Roles.zen";
This parameter is used to make sure that if multiple CSP applications are mapped to the same namespace that the CSP engine can correctly identify which class corresponds with which URL. If 'LockCSPName' is true (the default, defined in the CSP application) then you can only access this page if the url exactly matches this 'CSPURL'. You can set this parameter to "" if you wish to disable this check for this class. This check is applied for all CSP urls (cls/csp/zen).
If this page was compiled from a .csp file, then this parameter is automatically set to contain the url of this file used for compilation.
• parameter EMSSERVICE = "Security";
• parameter HELPADDRESS = "System Administration,Security,Roles";
Each SMP page should set this link which points to the documentation anchor name.
• parameter PAGENAME = "Roles";
Displayed name of this page.
• parameter RESOURCE = "%Admin_Secure";
Security requirement

Properties


• property colDelete as %ZEN.Datatype.caption [ InitialExpression = $$$Text("Delete") ];
Store translated targetCol linkCaption for

Methods


• method %GetLocatorLinks(Output pLink) as %Status
Return the array of links to show in the locator bar.
pLink(n)=$LB(caption,link)
• method %OnAfterCreatePage() as %Status
Be sure to do ##super() when overriding.
• method %OnGetPageName() as %String
Get the (localized) name of the page. This should be implemented in a subclass.
• classmethod Delete(role As %String) as %String [ ZenMethod ]
Delete selected role now.
• method OnDrawRibbon() as %Status
Add to the contents of the tool ribbon.
• method OnGetRibbonInfo(Output pDisplay As %Boolean, Output pViewIcons As %List, Output pSortOptions As %List, Output pSearchBox As %Boolean, Output pRibbonTitle As %String, Output pCommands As %List) as %Status
Get information to display in the ribbon bar.
• method doDelete(role) [ Language = javascript ]
Delete selected role
• method doEdit(role) [ Language = javascript ]
• method filterChanged(value, tableID) [ Language = javascript ]