%CSP.UI.SQL.QueryForm

class %CSP.UI.SQL.QueryForm extends %Library.RegisteredObject, %CSP.Util.AutoForm

This class is used internally by Caché. You should not make direct use of it within your applications. There is no guarantee made about either the behavior or future operation of this class.

This class implements the form used to execute user SQL queries within the Mgt Portal. It also includes some methods used to manage the query history.

Method Inventory

CreateInstance()
DrawHTMLForm()
OnDefineButtons()
OnSubmit()
QueryHistoryClose()
QueryHistoryExecute()
QueryHistoryFetch()

Properties

property MaxRows as %Integer (CAPTION = "Maximum Rows", MINVAL = 1);

Rows to display

Property methods: MaxRowsDisplayToLogical(), MaxRowsGet(), MaxRowsIsValid(), MaxRowsLogicalToDisplay(), MaxRowsNormalize(), MaxRowsSet()

property Query as %String (CAPTION = "SQL Query", MAXLEN = 10000);

Query text

Property methods: QueryDisplayToLogical(), QueryGet(), QueryIsValid(), QueryLogicalToDisplay(), QueryLogicalToOdbc(), QueryNormalize(), QuerySet()

property RuntimeMode as %String (CAPTION = "Data Display Mode", DISPLAYLIST = ",Logical Mode,ODBC Mode,Display Mode", MAXLEN = 50, VALUELIST = ",0,1,2");

Query run-time mode

Property methods: RuntimeModeDisplayToLogical(), RuntimeModeGet(), RuntimeModeIsValid(), RuntimeModeLogicalToDisplay(), RuntimeModeLogicalToOdbc(), RuntimeModeNormalize(), RuntimeModeSet()

Methods

classmethod CreateInstance(ByRef pID As %String) as %CSP.Util.AutoForm

Inherited description: Create an instance of the AutoForm object using the provided ID value(s). This is overridden by subclasses.
The default implementation will perform an OpenId if the AutoForm is a persistent object.

classmethod DrawHTMLForm(pObj As %RegisteredObject, ByRef pID As %String, pActionURL As %String = "", ByRef pButtons As FormButton, pTarget As %String = "") as %Status

Manual override of generated method.

classmethod OnDefineButtons(ByRef pButtons As %CSP.Util.FormButton)

define buttons

method OnSubmit(ByRef pID As %String, pSubmit As %String) as %Status

Inherited description: This callback is called when this form is submitted. pID is the ID value associated with the form. The default implementation will perform a Save if the AutoForm is a persistent object.
pSubmit is the name of the submit button (i.e., $AUTOFORM_SAVE).

classmethod QueryHistoryClose(ByRef qHandle As %Binary) as %Status

classmethod QueryHistoryExecute(ByRef qHandle As %Binary) as %Status

classmethod QueryHistoryFetch(ByRef qHandle As %Binary, ByRef Row As %List, ByRef AtEnd As %Integer = 0) as %Status

Queries

query QueryHistory()

Selects ID As %String, Query As %String

Returns query history list