This is documentation for Caché & Ensemble.

For information on converting to InterSystems IRIS, see the InterSystems IRIS Adoption Guide and the InterSystems IRIS In-Place Conversion Guide, both available on the WRC Distributions page (login required).

Home > Class Reference > ENSLIB namespace > EnsPortal.Dialog.ProductionItemSettings

EnsPortal.Dialog.ProductionItemSettings

class EnsPortal.Dialog.ProductionItemSettings extends EnsPortal.Dialog.standardDialog

This page allows the user to see the default values for specific settings and selectively reset them.

Property Inventory

Method Inventory

Parameters

parameter APPLYBUTTON = 0;
Inherited description: If true, then this dialog displays an Apply button.
parameter CANCELBUTTON = 1;
Inherited description: If true, then this dialog displays a Cancel button.
parameter OKBUTTON = 0;
parameter PAGENAME = Production Specific Settings;
Displayed name of this page.
parameter RESOURCE = %Ens_ProductionConfig:READ;
User needs READ permissions on the %Ens_ProductionConfig resource to view this page.

Properties

property ItemName as %String (ZENURL = "ITEMNAME");
Item Name
Property methods: ItemNameDisplayToLogical(), ItemNameGet(), ItemNameIsValid(), ItemNameLogicalToDisplay(), ItemNameLogicalToOdbc(), ItemNameNormalize(), ItemNameSet()
property NoOfResetableSettings as %Integer [ InitialExpression = 0 ];
Number of settings that are eligible to be reset
Property methods: NoOfResetableSettingsDisplayToLogical(), NoOfResetableSettingsGet(), NoOfResetableSettingsIsValid(), NoOfResetableSettingsLogicalToDisplay(), NoOfResetableSettingsNormalize(), NoOfResetableSettingsSet(), NoOfResetableSettingsXSDToLogical()
property ProductionName as %String (ZENURL = "PRODUCTION");
Production Name
Property methods: ProductionNameDisplayToLogical(), ProductionNameGet(), ProductionNameIsValid(), ProductionNameLogicalToDisplay(), ProductionNameLogicalToOdbc(), ProductionNameNormalize(), ProductionNameSet()

Methods

method %OnGetPageName() as %String
Get the (localized) name of the page.
method %OnGetSubtitle() as %String
Get the (localized) subtitle string for the dialog. This should be implemented in a subclass.
method %OnGetTitle() as %String
Get the (localized) title string for the page.
method DrawFooter(pSeed As %String) as %Status
method DrawHeader(pSeed As %String) as %Status
Draw messages at the top of the popup and initialize variable to track changes.
method DrawRow(name As %String, ByRef lblLocal As %String)
Draw a row for a setting.
method DrawTable(pSeed As %String) as %Status
Display table based on settings for the Production or item. $LB(Target,Value,ValueType,Default,DefaultType) (WAS: $lb(Target,Name,Value,ValueType,Default,DefaultType,Description,Type,MAXLEN,MINVAL,MAXVAL,VALUELIST,DISPLAYLIST,IsRequired)) ValueType tells you where this Value is coming from: $$$eConfigSettingValueTypeProperty: this value is from class definition property default; $$$eConfigSettingValueTypeSystem: this value is from the default settings; $$$eConfigSettingValueTypeProduction: this value is from Production definition. $$$eConfigSettingValueTypeRegistry: this value is from Registry DefaultType is similar to ValueType, it is the ValueType of the Default property: $$$eConfigSettingValueTypeProperty: this default value is from class definition property default; $$$eConfigSettingValueTypeSystem: this default value is from the default settings. pSeed = 0 is the initial load; pSeed = 1 is reset. Black means it's defined in the Production; Blue means it's coming from default settings; Green means it's coming from class definition.
classmethod StateTrack(pChecked As %Boolean, pName As %String) as %Boolean [ ZenMethod ]
Set session info to keep track of changes made here.
classmethod ThereAreModifications() as %Boolean [ ZenMethod ]
Return a value indicating if the user has modified any of the settings in this window.
clientmethod closeThisWindow() [ Language = javascript ]
Close the dialog popup; the modifications are passed back via session data.
clientmethod getDialogValue() [ Language = javascript ]
Inherited description: Get the value that will be applied when the user presses the OK button. This is implemented by subclasses.
clientmethod ondialogFinish(action) as %Boolean [ Language = javascript ]
This callback is called when the user presses the OK button. If this returns false, then the action is canceled.
clientmethod onloadHandler() [ Language = javascript ]
This client event, if present, is fired when the page is loaded.
clientmethod setToDefault(name, isMod) [ Language = javascript ]
Handle check/uncheck of a setting.

Inherited Members

Inherited Properties

Inherited Methods