Skip to main content

%DeepSee.UI.TermListManager

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).

Property Inventory

Method Inventory

Parameters

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

Properties

property replaceExisting as %ZEN.Datatype.string (ZENURL = "REPLACE");
Property methods: replaceExistingDisplayToLogical(), replaceExistingGet(), replaceExistingIsValid(), replaceExistingLogicalToDisplay(), replaceExistingLogicalToOdbc(), replaceExistingNormalize(), replaceExistingSet()
property termListName as %ZEN.Datatype.string (ZENURL = "TERMLIST");
Name of term list.
Property methods: termListNameDisplayToLogical(), termListNameGet(), termListNameIsValid(), termListNameLogicalToDisplay(), termListNameLogicalToOdbc(), termListNameNormalize(), termListNameSet()

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.
clientmethod addColumn() [ Language = javascript ]
Add a new column.
clientmethod addRow() [ Language = javascript ]
Add a new record.
clientmethod adjustSizes() [ Language = javascript ]
Adjust sizes of components on the page.
clientmethod arrowHandler(which) [ Language = javascript ]
Arrow handler for grid.
clientmethod browseSubjectAreas() [ Language = javascript ]
Launch the subject area finder.
clientmethod canUserModify() [ Language = javascript ]
Test if the user has write privilege.
clientmethod changeTermList() [ Language = javascript ]
Launch the term list finder dialog.
clientmethod deleteColumn() [ Language = javascript ]
Delete a new column.
clientmethod deleteTermList() [ Language = javascript ]
Delete the termlist.
clientmethod exportTermList() [ Language = javascript ]
Export the termlist.
clientmethod formChanged(ctrl) [ Language = javascript ]
Change to details form.
clientmethod getGrid() [ Language = javascript ]
Get the grid component.
clientmethod 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 ]
clientmethod gridKeyDown(evt) [ Language = javascript ]
Key down handler for grid.
clientmethod headerClick(which, index) [ Language = javascript ]
Click on header in grid.
clientmethod hideValueColumn(flag) [ Language = javascript ]
Hide/show the value column.
clientmethod newTermList() [ Language = javascript ]
Create a new term list.
clientmethod onPopupAction(popupName, action, value) [ Language = javascript ]
This client event is fired when the a popup page launched from this page fires an action.
clientmethod onlayoutHandler(load) [ Language = javascript ]
Adjust sizes of components on the page.
method overwriteTermList(pStreamId As %Integer, pTermListName) as %Status [ ZenMethod ]
clientmethod removeRow() [ Language = javascript ]
Remove a record.
clientmethod saveTermList(rename) [ Language = javascript ]
Save the termlist.
clientmethod searchBoxHandler(searchKey) [ Language = javascript ]
Change in search box value. Can be overridden by subclasses.
method termListExists(pTermListName As %String) as %Boolean [ ZenMethod ]
clientmethod updateForm() [ Language = javascript ]
Update details form.

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab