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

EnsPortal.Dialog.AgentInterface

class EnsPortal.Dialog.AgentInterface extends EnsPortal.Dialog.standardDialog

This dialog lets the user create or edit a context propery within a Business Process.

Property Inventory (Including Private)

Method Inventory (Including Private)

Parameters

parameter APPLYBUTTON = 0;
Inherited description: If true, then this dialog displays an Apply button.
parameter EDITRESOURCE = %Ens_Agents:WRITE;
User needs WRITE permissions on the %Ens_Agents resource to view this page.
parameter RESOURCE = %Ens_Agents:READ;
User needs READ permissions on the %Ens_Agents resource to view this page.

Properties (Including Private)

property AgentName as %ZEN.Datatype.integer (ZENURL = "NAME");
name of agent
Property methods: AgentNameDisplayToLogical(), AgentNameGet(), AgentNameIsValid(), AgentNameLogicalToDisplay(), AgentNameLogicalToOdbc(), AgentNameNormalize(), AgentNameSet()
property ClientID as %ZEN.Datatype.string (ZENURL = "ID");
ClientId of this interface
Property methods: ClientIDDisplayToLogical(), ClientIDGet(), ClientIDIsValid(), ClientIDLogicalToDisplay(), ClientIDLogicalToOdbc(), ClientIDNormalize(), ClientIDSet()
property readOnly as %ZEN.Datatype.boolean (ZENURL = "READONLY");
ReadOnly flag.
Property methods: readOnlyDisplayToLogical(), readOnlyGet(), readOnlyIsValid(), readOnlyLogicalToDisplay(), readOnlyLogicalToOdbc(), readOnlyLogicalToXSD(), readOnlyNormalize(), readOnlySet(), readOnlyXSDToLogical()

Methods (Including Private)

method %OnAfterCreatePage() as %Status
Inherited description: Avoid writing out the session cookie if we are in a Studio session.
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 dialog. This should be implemented in a subclass.
clientmethod ctrlKeyDown(evt, escOnly) [ Language = javascript ]
Key handler for value edit control.
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, if defined, is called when the user presses the OK or Apply action buttons. If this returns false, then the action is cancelled.
clientmethod ondialogStart() [ Language = javascript ]
This callback, if defined, is called when the dialog page is loaded.
clientmethod populateControls(obj, propName) [ Language = javascript ]
clientmethod revealOptions() [ Language = javascript ]

Inherited Members

Inherited Properties (Including Private)