Home > Class Reference > ENSLIB namespace > Ens.DTL.Assign
Private  Storage   


class Ens.DTL.Assign extends Ens.DTL.Action

The syntax specifies a target object and an expression that will be assigned to it:- Assignments can specify the 'action' attribute which determines how the assignment is performed. Legal values for the 'action' attribute are:- Append,Clear, Insert,Remove and Set. If this attribute is not specified, the default value is 'Set'. Append,Clear, Insert and Remove are only applicable when the object being accessed is a collection of type 'list' or 'array'. Depending upon the type of assignment, an additional attribute 'key' may be required. Here is a table which determines which attributes are required to effect a particular type of assignment. Property Type Assignment Action Key Required Result ------------- --------------- ------------ ------ Non-collection Set No Property is set to new value Array Clear No Array is cleared Array Remove Yes Element at Key is removed Array Set Yes Element at Key is set to new value List Append No Element is added to the end of the list List Clear No List is cleared List Insert Yes Element is inserted at position determined by Key List Remove Yes Element at Key is removed List Set Yes Element at Key is replaced


Parameters Properties Methods Queries Indices ForeignKeys Triggers
1 4 6


Action Annotation Disabled Key Parent
Property Value

%AddToSaveSet %ClassIsLatestVersion %ClassName %ConstructClone
%DispatchClassMethod %DispatchGetModified %DispatchGetProperty %DispatchMethod
%DispatchSetModified %DispatchSetMultidimProperty %DispatchSetProperty %Extends
%GetParameter %IsA %IsModified %New
%NormalizeObject %ObjectModified %OriginalNamespace %PackageName
%RemoveFromSaveSet %SerializeObject %SetModified %ValidateObject
Deserialize DisplayName GenerateCode GenerateXML
NormalizeAttribute Serialize Validate WriteAnnotationXML


• parameter TAGNAME = "assign";


• property Action as %String [ InitialExpression = "set" ];
This holds the type of the assignment
• property Key as %String [ InitialExpression = """""" ];
This holds the key ( optional ) used for certain types of assignment operations on properties which are collections (array or list)
• property Property as %String;
This holds the name of the target
• property Value as %String;
This holds the value to assign to the property


• method Deserialize(pState As %String) as %Status
Fill in properties of this item from the serial string
• method DisplayName() as %String
Provide a user readable string which identifies this node
• method GenerateCode(pCompiler As Ens.DTL.Compiler) as %Status
• method GenerateXML(pStream As %BinaryStream) as %Status
• method Serialize(pStream As %CharacterStream) as %Status
Serialize this transform for use by DTL editor
• method Validate(ByRef pStatus As %Status, pContext As Ens.DTL.ValidationContext) as %Status
Perform a sanity check on the nodes in the parse tree