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

class %DeepSee.UI.TermListManager extends %DeepSee.UI.standardPage

DeepSee term list manager page. This page lets you view and edit "term lists" (lookup tables used by DeepSee models).

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
4 2 38


Summary

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

Properties
%condition %import %includeFiles %page
%resource StdTitle aboutPage align
aux backgroundTimerInterval cellAlign cellSize
cellStyle cellVAlign children composite
contactPage containerStyle cssLevel currSortMode
currStep currViewMode disabled docbookId
dragAndDrop dragEnabled dropEnabled enableAutoRefresh
enclosingClass enclosingStyle error groupClass
groupStyle height hidden hint
hintClass hintStyle homePage id
index label labelClass labelDisabledClass
labelPosition labelStyle layout limitPopups
metaData name onafterdrag onbeforedrag
onclick ondrag ondrop onhide
onrefresh onshow onupdate pageModified
parent replaceExisting searchKey showLabel
slice termListName title tuple
useSVG useSoftModals valign visible
width window zenPersistentPopup

Methods
%AddChild %AddChildAfter %AddChildBefore %AddComponent
%AddImportedComponents %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 %GetLinks %GetLocatorLinks
%GetPageName %GetParameter %GetRootLink %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 CheckContextLinks CheckEnterpriseManager
ConvertParameter Decrypt Delete DoLogout
DrawHelp DrawLocator DrawRibbon DrawTitle
Encrypt EscapeHTML EscapeURL GetCSPURL
GetContextLinks GetDocURL GetNewURL GetQuickLinks
GetTermListContent HyperEventCall HyperEventHead Include
InsertHiddenField InsertHiddenFields IsPrivate JavaInstalled
Link OnDrawRibbon OnGetRibbonInfo OnHTTPHeader
OnPage OnPageError OnPostHTTP OnPostHyperEvent
OnPreHTTP OnPreHyperEvent Page QuoteJS
RewriteURL ShowError StartTimer StopTimer
SubmitTermList ThrowError UnescapeHTML UnescapeURL
XMLDTD XMLExport XMLExportToStream XMLExportToString
XMLNew XMLSchema XMLSchemaNamespace XMLSchemaType
addChild addChildAfter addChildBefore addColumn
addRow adjustSizes arrowHandler browseSubjectAreas
canUserModify cancelPopup changePassword changeTermList
changeTermListFromUpload childrenMutated correctIELayering createComponent
createComponentNS deleteColumn deleteComponent deleteTermList
disableCommandButton dragFinishHandler dragHandler dragNotifyHandler
dragStartHandler dropHandler dropStartHandler enableCommandButton
endModal exportTermList exposeComponent findElement
fireOnResizeEvent fireOnUnloadEvent fireOnUpdateEvent firePopupAction
formChanged getChildIndex getComponent getComponentById
getEnclosingDiv getGrid getHidden getHintElement
getLabelElement getOpener getPageMeta getPageTitle
getProperty getSettings getTermListNameFromStream getTitleAreaHeight
getType goHome goMenu gotoNamespace
gotoPage gridKeyDown headerClick hideCommandButton
hideValueColumn invokeSuper isOfType launchPopupWindow
logout makeId navigate newTermList
onCreate onDelete onDisplayHandler onEndModalHandler
onPopupAction onRefreshContents onSerialize onServerMethodCall
onServerMethodError onServerMethodReturn onStartModalHandler ondisabledHandler
onhandleAutoLogoutWarn onkeydownHandler onkeyupHandler onlayoutHandler
onloadHandler onlogoutHandler onoverlayHandler onresizeHandler
onunloadHandler onupdateHandler overwriteTermList popupActionHandler
refreshContents reloadPage removeChild removeRow
render renderContents renderSVG saveTermList
searchBlur searchBoxHandler searchFocus searchKeyDown
searchKeyPress setComponentId setConnectivityStatusMsg setHidden
setModified setOverlayMode setPageTitle setProperty
setPropertyAll setSortMode setSortModeHandler setTraceOption
setViewMode setViewModeHandler showAbout showCommandButton
showContact showHelp startModal startProgressBar
stopProgressBar switchNamespace termListExists updateForm


Parameters

• parameter DEFAULTVIEWMODE;
If this page has multiple views, this is its initial display mode.
• parameter DOCBOOKID = "D2MODADV_ch_term_list";
Docbook ID for this page.
• parameter PAGENAME = "Term List Manager";
Displayed name of this page.
• parameter RESOURCE = "%DeepSee_PortalEdit";
All Analytics pages require %DeepSee_Portal USE.

Properties

• property replaceExisting as %ZEN.Datatype.string(ZENURL="REPLACE");
• property termListName as %ZEN.Datatype.string(ZENURL="TERMLIST");
Name of term list.

Methods

• method %OnAfterCreatePage() as %Status
This class method callback is called just before the server-side page object is created.
• method %OnGetPageName() as %String
Get the (localized) name of the page.
• method %OnGetProductName() as %String
Get the product name for the page.
• method %OnGetTitle() as %String
Get the (localized) title string for the page. This should be implemented in a subclass.
• classmethod %OnPreHTTP() as %Boolean
Test for additional resources.
• classmethod %OnSubmit(pSubmit As %ZEN.Submit) as %Status
This callback is called when the upload form on this page is submitted. pSubmit is a %ZEN.Submit object containing details of the form submit.
• method Delete(pName As %String) as %String [ ZenMethod ]
Delete a term list.
• method DrawHelp(pSeed As %String) as %Status
Draw the help panel.
• method GetTermListContent(ByRef pParameters, Output pObject As %RegisteredObject) as %Status
Get content object for JSON provider.
• 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 SubmitTermList(pCommand As %String, pProvider As %ZEN.Auxiliary.jsonProvider, pSubmitObject As %RegisteredObject, ByRef pResponseObject As %RegisteredObject) as %Status
Object submit handler JSON provider. This is called when the client saves the term list.
• method addColumn() [ Language = javascript ]
Add a new column.
• method addRow() [ Language = javascript ]
Add a new record.
• method adjustSizes() [ Language = javascript ]
Adjust sizes of components on the page.
• method arrowHandler(which) [ Language = javascript ]
Arrow handler for grid.
• method browseSubjectAreas() [ Language = javascript ]
Launch the subject area finder.
• method canUserModify() [ Language = javascript ]
Test if the user has write privilege.
• method changeTermList() [ Language = javascript ]
Launch the term list finder dialog.
• method changeTermListFromUpload() [ Language = javascript ]
User has selected a new term list.
• method deleteColumn() [ Language = javascript ]
Delete a new column.
• method deleteTermList() [ Language = javascript ]
Delete the termlist.
• method exportTermList() [ Language = javascript ]
Export the termlist.
• method formChanged(ctrl) [ Language = javascript ]
Change to details form.
• method getGrid() [ Language = javascript ]
Get the grid component.
• method getPageTitle() as %String [ Language = javascript ]
Get the title string to add to the locator row. This should be implemented in a subclass.
• method getTermListNameFromStream(pStreamId As %Integer) as %String [ ZenMethod ]
• method gridKeyDown(evt) [ Language = javascript ]
Key down handler for grid.
• method headerClick(which, index) [ Language = javascript ]
Click on header in grid.
• method hideValueColumn(flag) [ Language = javascript ]
Hide/show the value column.
• method newTermList() [ Language = javascript ]
Create a new term list.
• method onPopupAction(popupName, action, value) [ Language = javascript ]
This client event is fired when the a popup page launched from this page fires an action.
• method onlayoutHandler(load) [ Language = javascript ]
Adjust sizes of components on the page.
• method overwriteTermList(pStreamId As %Integer, pTermListName) as %Status [ ZenMethod ]
• method removeRow() [ Language = javascript ]
Remove a record.
• method saveTermList(rename) [ Language = javascript ]
Save the termlist.
• method searchBoxHandler(searchKey) [ Language = javascript ]
Change in search box value. Can be overridden by subclasses.
• method termListExists(pTermListName As %String) as %Boolean [ ZenMethod ]
• method updateForm() [ Language = javascript ]
Update details form.


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