Class Reference
IRIS for UNIX 2019.2
InterSystems: The power behind what matters   
Documentation  Search
  [%SYS] >  [%ZEN] >  [Submit]
Private  Storage   

class %ZEN.Submit extends %RegisteredObject

This object is used to hold values and details of a Submit operation.

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
8 5


Summary

Properties
%Action %Data %Errors %FormId
%FormKey %ModelClass %NextPage %SkipProcessing

Methods
%AddToSaveSet %ClassIsLatestVersion %ClassName %ConstructClone
%DispatchClassMethod %DispatchGetModified %DispatchGetProperty %DispatchMethod
%DispatchSetModified %DispatchSetMultidimProperty %DispatchSetProperty %Extends
%GetParameter %GetStream %GetValue %HasErrors
%IsA %IsModified %New %NormalizeObject
%ObjectModified %OriginalNamespace %PackageName %RemoveFromSaveSet
%SerializeObject %SetError %SetModified %SetValue
%ValidateObject


Properties

• property %Action as %String;
Name of submit action. This comes from the action property of the %ZEN.Component.submit that submitted this form.
• property %Data as %String [ MultiDimensional ];
Internal property.
Array of submitted values, indexed by control name.
• property %Errors as %String [ MultiDimensional ];
Internal property.
Array of errors in submitted values, indexed by control name.
• property %FormId as %String;
Component id of the submitted form (if defined).
• property %FormKey as %String;
Key value (object id) associated with the submitted form (if any).
If the form defines an OnLoadForm callback, this contains the user-supplied key value used to load data for the form.
If the form is bound to a DataModel, this contains the id of the DataModel object.
• property %ModelClass as %String;
If the form is bound to a DataModel class, this is the name of the DataModel class.
• property %NextPage as %String;
Page to redirect to after a submit.
This is initially set to the submitting form's nextPage property but can be modified by an %OnSubmit method.
• property %SkipProcessing as %Boolean [ InitialExpression = 0 ];
Internal Property.
If true, bypass the rest of the submit processing for this page.

Methods

• method %GetStream(pCompName As %String)
Get a pointer to a MIME stream associated with a control by name
• method %GetValue(pCompName As %String)
Get value associated with a control by name.
• method %HasErrors() as %Boolean
Return true if errors have been added to this submit object.
• method %SetError(pCompName As %String, pError As %String)
Associate an error message with a component by name.
• method %SetValue(pCompName As %String, pValue As %String = "")
Set the value associated with a control by name.
This value will be applied to the control if the form is redisplayed because of errors.


Copyright (c) 2019 by InterSystems Corporation. Cambridge, Massachusetts, U.S.A. All rights reserved. Confidential property of InterSystems Corporation.