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

class %CSP.UI.Portal.Locks extends %CSP.UI.Portal.LocksView

System Management Portal - System Operations - Manage Locks

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
3 2 6


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 Namespace
OnclickArray PID ParentURL ShowSQL
StdTitle TableMaxRows TablePageSize ValidationErrorMsg
aboutPage align aux backgroundTimerInterval
captionLastUpdate cellAlign cellSize cellStyle
cellVAlign children colProcess colRemoteClient
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
DoLogout DrawAutoRefresh DrawLocator DrawRibbon
DrawSQLColumn DrawTitle Encrypt EscapeHTML
EscapeURL EvalResult GetCSPURL GetContextLinks
GetDocURL GetHomePage GetNewURL GetQuickLinks
HyperEventCall HyperEventHead InTransaction Include
InsertHiddenField InsertHiddenFields IsPrivate JavaInstalled
LastUpdateTime Link OnDrawRibbon OnGetRibbonInfo
OnHTTPHeader OnPage OnPageError OnPostHTTP
OnPostHyperEvent OnPreHTTP OnPreHyperEvent Page
QuoteJS RegisterRecent RemoveLocks 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
displaySqlOptions displayroutine doCancel doModified
doRemove doRemoveRemote 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
hideThisColumn invokeSuper isButtonDisabled isOfType
launchPopupWindow logout makeId navMaxRowsChanged
navPageSizeChanged navigate onCreate onDelete
onDisplayHandler onEndModalHandler onPopupAction onRefreshContents
onSerialize onServerMethodCall onServerMethodError onServerMethodReturn
onStartModalHandler ondisabledHandler onhandleAutoLogoutWarn 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 setNamespaceFilter 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 CSPURL = "/csp/sys/op/%CSP.UI.Portal.Locks.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 HELPADDRESS = "Home,Locks";
Each SMP page should set this link which points to the documentation anchor name.
• parameter PAGENAME = "Manage Locks";
Displayed name of this page.

Properties

• property colProcess as %ZEN.Datatype.caption [ InitialExpression = $$$Text("Remove_all_locks_for_process") ];
Store translated targetCol linkCaption for
• property colRemoteClient as %ZEN.Datatype.caption [ InitialExpression = $$$Text("Remove_all_locks_from_remote_client") ];

Methods

• 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 InTransaction(DeleteID) as %String [ ZenMethod ]
This method is called to check whether a local lock is currently in an option transaction.
• classmethod RemoveLocks(DeleteID, RemoveAllLocksForProcess) as %ZEN.proxyObject [ ZenMethod ]
Remove locks from server. If RemoveAllLocksForProcess, then DeleteID is PID. OW DeleteID contains three pieces lock reference delimited by comma.
• method doRemove(DeleteID, RemoveAll, RemoteOwner) [ Language = javascript ]
Remove a lock. If "RemoveAll" is 1 then all locks for that process is removed. If RemoveAll is 0, then DeleteID is the lock reference. If RemoveAll is 1, then DeleteID is the Pid/Client or Owner.
• method doRemoveRemote(DeleteID, RemoveAll, RemoteOwner) [ Language = javascript ]
To remove all remote add "C" as preface.


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