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

%CSP.UI.Portal.Role


class %CSP.UI.Portal.Role extends %CSP.UI.Portal.Template

System Management Portal - System Administration - Edit Role

Inventory


Parameters Properties Methods Queries Indices ForeignKeys Triggers
8 8 22


Summary


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

Properties
%condition %import %includeFiles %page
%resource CurrResources CurrTab EditDisabled
FirstFailed HelpAddress ISREADONLY InvalidParam
IsDB IsEMSReadOnly IsEditForm IsNewSave
IsSystem LocatorHeader NumTabs OnclickArray
PID ParentURL StdTitle ValidationErrorMsg
aboutPage align aux backgroundTimerInterval
cellAlign cellSize cellStyle cellVAlign
children 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 %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 CheckAllBlanks CheckContextLinks CheckEnterpriseManager
ConvertParameter CopyRole Decrypt DeleteResource
DoLogout DrawLocator DrawResources DrawRibbon
DrawTabHeader DrawTitle Encrypt EscapeHTML
EscapeURL EvalResult GetCSPURL GetContextLinks
GetDocURL GetHomePage GetNewURL GetQuickLinks
HyperEventCall HyperEventHead Include InsertHiddenField
InsertHiddenFields IsPrivate Link OnDrawRibbon
OnGetRibbonInfo OnHTTPHeader OnPage OnPageError
OnPostHTTP OnPostHyperEvent OnPreHTTP OnPreHyperEvent
Page PopulateFields PopulateNSDropdown QuoteJS
RegisterRecent RewriteURL SaveData ShowError
StartTimer StopTimer ThrowError UnescapeHTML
UnescapeURL XMLDTD XMLExport XMLExportToStream
XMLExportToString XMLNew XMLSchema XMLSchemaNamespace
XMLSchemaType addChild addChildAfter addChildBefore
afterSave afterValidate cancelPopup changeNS
changePassword childrenMutated correctIELayering createComponent
createComponentNS deleteComponent disableCommandButton doAddResource
doCancel doCopyRole doDeleteResource doEditResource
doModified doSave dragFinishHandler dragHandler
dragNotifyHandler dragStartHandler dropHandler dropStartHandler
enableCommandButton endModal exposeComponent findElement
fireOnResizeEvent fireOnUnloadEvent fireOnUpdateEvent firePopupAction
getChildIndex getComponent getComponentById getEnclosingDiv
getHidden getHintElement getLabelElement getOpener
getPageTitle getProperty getSettings getTitleAreaHeight
getType goHome goMenu gotoNamespace
gotoPage hideCommandButton invokeSuper isButtonDisabled
isOfType launchPopupWindow logout makeId
navigate onCreate onDelete onDisplayHandler
onEndModalHandler onPopupAction onRefreshContents onSerialize
onServerMethodCall onServerMethodError onServerMethodReturn onStartModalHandler
ondisabledHandler onkeydownHandler onkeyupHandler onlayoutHandler
onloadHandler onlogoutHandler onoverlayHandler onresizeHandler
onunloadHandler onupdateHandler popupActionHandler refreshContents
removeChild render renderContents renderSVG
resetMsg searchBlur searchBoxHandler searchFocus
searchKeyDown searchKeyPress setComponentId setConnectivityStatusMsg
setHidden setModified setOverlayMode setPageTitle
setProperty setPropertyAll setSortMode setSortModeHandler
setTraceOption setViewMode setViewModeHandler showAbout
showCommandButton showContact showDocumentation showHelp
showMsg startModal startProgressBar stopProgressBar
switchNamespace tabChanged trimSpace validate
validateRequired


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.Role.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,Users,Edit Role";
Each SMP page should set this link which points to the documentation anchor name.
• parameter PAGENAME = "Edit Role";
Displayed name of this page.
• parameter PARENTPAGE = "/csp/sys/sec/%CSP.UI.Portal.Roles.zen";
This parameter defines the parent page for this page.
If the name ends in .csp, then the parent is assumed to be an autopage-enabled CSP page.
If the name ends in .cls, then the parent is assumed to be a Zen page.
This is used to automate the construction of the locator bar for this page and to build the index between portal pages and documentation.
The %GetLocatorInfo method is used to get this information.
• parameter RECENT = 0;
If true, register visits to this page in the recent list.
• parameter RESOURCE = "%Admin_Secure";
Security requirement

Properties


• property CurrResources as %String;
• property CurrTab as %Integer [ InitialExpression = 0 ];
• property EditDisabled as %Boolean;
• property IsDB as %Boolean [ InitialExpression = 0 ];
• property IsEditForm as %Boolean [ InitialExpression = 1 ];
If set to 1 then the generic Save and Cancel button will be shown on the ribbon bar.
• property IsNewSave as %Integer(ZENURL="new");
• property IsSystem as %Boolean [ InitialExpression = 0 ];
• property NumTabs as %Integer [ InitialExpression = 7 ];

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.
• method CopyRole(Role As %String) as %Status [ ZenMethod ]
• classmethod DeleteResource(pProxy As %ZEN.proxyObject) as %ZEN.proxyObject [ ZenMethod ]
• method DrawResources(pSeed As %String) as %Status
• method DrawTabHeader(pSeed As %String) as %Status
• method PopulateFields(ByRef Properties As %String) as %Status
Fill in form fields. Used when loading the page for edit or when choosing a copy from role during creation
• method PopulateNSDropdown(Type As %Integer, Output displayList As %String, Output valueList As %String) as %Status
• classmethod SaveData(pProxy As %ZEN.proxyObject) as %ZEN.proxyObject [ ZenMethod ]
Call server save method.
• method changeNS(ns) [ Language = javascript ]
• method doAddResource() [ Language = javascript ]
• method doCopyRole(role) [ Language = javascript ]
• method doDeleteResource(resource) [ Language = javascript ]
• method doEditResource(resource, permissions) [ Language = javascript ]
• method doSave() [ Language = javascript ]
• method getPageTitle() as %String [ Language = javascript ]
Get the title string to add to the locator row.
• method onPopupAction(popupName, action, value) [ Language = javascript ]
This client event, if present, is fired when the a popup page launched from this page fires an action.
• method onlayoutHandler(load) [ Language = javascript ]
This client event, if present, is fired when the page is first loaded or whenever it is resized.
If this is called at load time, then load will be true.
• method onloadHandler() [ Language = javascript ]
Set focus to the Name or Description field, disable fields if DispatchClass is defined.
• method tabChanged(index) [ Language = javascript ]
• method validate() as %Boolean [ Language = javascript ]