CSPX.EnsSuspendedMsgForm

class CSPX.EnsSuspendedMsgForm extends %Library.RegisteredObject, %CSP.Util.AutoForm

Property Inventory

EndId
EndTime
Id
IsError
MaxRows
SessionStart
SortOrder
StartId
StartTime
Status
Type

Method Inventory

CreateInstance()
OnDefineButtons()
OnSubmit()

Parameters

parameter DOMAIN = Ensemble;

Use our own domain for localization

Properties

property EndId as %Integer (CAPTION = "@Ensemble:EndId@End Id");

End ID value

Property methods: EndIdDisplayToLogical(), EndIdGet(), EndIdIsValid(), EndIdLogicalToDisplay(), EndIdNormalize(), EndIdSet()

property EndTime as %TimeStamp (CAPTION = "@Ensemble:EndTime@End Time");

End date

Property methods: EndTimeDisplayToLogical(), EndTimeGet(), EndTimeIsValid(), EndTimeLogicalToDisplay(), EndTimeNormalize(), EndTimeOdbcToLogical(), EndTimeSet()

property Id as %Integer (CAPTION = "@Ensemble:Id@");

User may enter a Id

Property methods: IdDisplayToLogical(), IdGet(), IdIsValid(), IdLogicalToDisplay(), IdNormalize(), IdSet()

property IsError as %String (CAPTION = "@Ensemble:IsError@Is Error", DISPLAYLIST = ",false,true", VALUELIST = ",0,1");

Errors

Property methods: IsErrorDisplayToLogical(), IsErrorGet(), IsErrorIsValid(), IsErrorLogicalToDisplay(), IsErrorLogicalToOdbc(), IsErrorNormalize(), IsErrorSet()

property MaxRows as %Integer (CAPTION = "@Ensemble:MaxRows@Max Rows", MAXVAL = 500, MINVAL = 1);

Number of rows to display

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

property SessionStart as %String (CAPTION = "@Ensemble:SessionStart@", DISPLAYLIST = ",All messages,Initial messages", VALUELIST = ",0,1");

Only show messages that start session

Property methods: SessionStartDisplayToLogical(), SessionStartGet(), SessionStartIsValid(), SessionStartLogicalToDisplay(), SessionStartLogicalToOdbc(), SessionStartNormalize(), SessionStartSet()

property SortOrder as %String (CAPTION = "@Ensemble:SortOrder@Sort Order", DISPLAYLIST = ",Oldest First,Newest First", VALUELIST = ",1,2");

How to sort data

Property methods: SortOrderDisplayToLogical(), SortOrderGet(), SortOrderIsValid(), SortOrderLogicalToDisplay(), SortOrderLogicalToOdbc(), SortOrderNormalize(), SortOrderSet()

property StartId as %Integer (CAPTION = "@Ensemble:StartId@Start Id");

Starting ID value

Property methods: StartIdDisplayToLogical(), StartIdGet(), StartIdIsValid(), StartIdLogicalToDisplay(), StartIdNormalize(), StartIdSet()

property StartTime as %TimeStamp (CAPTION = "@Ensemble:StartTime@Start Time");

Starting date

Property methods: StartTimeDisplayToLogical(), StartTimeGet(), StartTimeIsValid(), StartTimeLogicalToDisplay(), StartTimeNormalize(), StartTimeOdbcToLogical(), StartTimeSet()

property Status as Ens.DataType.MessageStatus (CAPTION = "@Ensemble:Status@Status");

Message status

Property methods: StatusDisplayToLogical(), StatusGet(), StatusIsValid(), StatusLogicalToDisplay(), StatusNormalize(), StatusSet()

property Type as Ens.DataType.MessageType (CAPTION = "@Ensemble:Type@Type");

Message types

Property methods: TypeDisplayToLogical(), TypeGet(), TypeIsValid(), TypeLogicalToDisplay(), TypeNormalize(), TypeSet()

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 OnDefineButtons(ByRef pButtons As %CSP.Util.FormButton)

define standard Login 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).