Class Reference
IRIS for UNIX 2019.2
InterSystems: The power behind what matters   
Documentation  Search
  [ENSLIB] >  [Ens] >  [BPL] >  [Property]
Private  Storage   

class Ens.BPL.Property extends Ens.BPL.Node

This defines a property which will appear in the processes context and as such properties may only be defined as elements within a tag. A property MUST have a name. If the 'collection' attribute is set ( either 'array' or 'list') then the property will be automatically instantiated as a collection of that type. For non-collection properties the 'initialexpression' and 'instantiate' attributes dictate how the object will be intialized. If 'instantiate' is set to 'true' (1), then a call to new the object will be generated. If an 'initialexpression' is specified then the result of the expression will be assigned to the object. Note that 'instantiate' should be used to initialize properties of instantible type, whilst 'initialexpression' should be used to intialize datatype classes such as %String.

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
7 5


Summary

Properties
Annotation Collection InitialExpression Instantiate
Name Parameters Parent Type

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


Properties

• property Annotation as %String(MAXLEN="");
This holds the user documentation for this property
• property Collection as %String;
This holds the (optional) collection type Collections may be of type 'array' or 'list' only
• property InitialExpression as %String;
This holds the (optional) initial expression
• property Instantiate as %Boolean;
This holds the (optional) create flag. If set to true then the property will be instantiated in on creation of the containg context class
• property Name as %String;
This holds the name of the property
• property Parameters as array of %String;
This holds the (optional) parameters
• property Type as %String;
This holds the value to assign to the property

Methods

• method DisplayName() as %String
Provide a user readable string which names the activity
• method GenerateCode(pCompiler As Ens.BPL.Compiler) as %Status
• method GenerateXML(pStream As %BinaryStream) as %Status
• method InstantiateSet(pValue) as %Status
Setter for instantiate (true,false,0 or 1 allowed by schema)
• method Validate(ByRef pStatus As %Status, pContext As Ens.BPL.ValidationContext) as %Status
Perform a sanity check on the nodes in the parse tree


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