Home > Class Reference > ENSLIB namespace > %ZEN.Auxiliary.dataBag

%ZEN.Auxiliary.dataBag

class %ZEN.Auxiliary.dataBag extends %ZEN.Component.object

This class provides a way to assemble data that can be conveniently passed between the web client and the server. A dataBag object contains a set of name-value pairs. This is used internally by the MVC classes.

Property Inventory (Including Private)

Method Inventory (Including Private)

Properties (Including Private)

property %data as %ZEN.Datatype.string (XMLPROJECTION = "NONE") [ MultiDimensional ];
Array of data values within the dataBag, indexed by series and property name.
Property methods: %dataDisplayToLogical(), %dataGet(), %dataIsValid(), %dataLogicalToDisplay(), %dataLogicalToOdbc(), %dataNormalize(), %dataSet()
property %labels as %ZEN.Datatype.string (XMLPROJECTION = "NONE") [ MultiDimensional ];
Array of labels within the dataBag, indexed by property name.
Property methods: %labelsDisplayToLogical(), %labelsGet(), %labelsIsValid(), %labelsLogicalToDisplay(), %labelsLogicalToOdbc(), %labelsNormalize(), %labelsSet()
property %types as %ZEN.Datatype.string (XMLPROJECTION = "NONE") [ MultiDimensional ];
Array of data types within the dataBag, indexed by property name.
Property methods: %typesDisplayToLogical(), %typesGet(), %typesIsValid(), %typesLogicalToDisplay(), %typesLogicalToOdbc(), %typesNormalize(), %typesSet()
property clientData as %ZEN.Datatype.list (XMLPROJECTION = "NONE", ZENSETTING = 0);
Array of serialized data values going to and coming from the client.
Property methods: clientDataDisplayToLogical(), clientDataGet(), clientDataIsValid(), clientDataLogicalToDisplay(), clientDataLogicalToOdbc(), clientDataNormalize(), clientDataSet()
property labelList as %ZEN.Datatype.csv (XMLPROJECTION = "NONE") [ Private ];
List of property labels (if different than property name) contained within this dataBag.
Property methods: labelListDisplayToLogical(), labelListGet(), labelListIsValid(), labelListLogicalToDisplay(), labelListLogicalToOdbc(), labelListNormalize(), labelListSet()
property propertyList as %ZEN.Datatype.csv (XMLPROJECTION = "NONE") [ Private ];
List of property names contained within this dataBag.
Property methods: propertyListDisplayToLogical(), propertyListGet(), propertyListIsValid(), propertyListLogicalToDisplay(), propertyListLogicalToOdbc(), propertyListNormalize(), propertyListSet()
property propertyTypes as %ZEN.Datatype.csv (XMLPROJECTION = "NONE") [ Private ];
List of types of the properties contained within this dataBag.
Property methods: propertyTypesDisplayToLogical(), propertyTypesGet(), propertyTypesIsValid(), propertyTypesLogicalToDisplay(), propertyTypesLogicalToOdbc(), propertyTypesNormalize(), propertyTypesSet()
property seriesCount as %ZEN.Datatype.integer (MINVAL = 1, XMLPROJECTION = "NONE", ZENSETTING = 0) [ InitialExpression = 1 ];
Number of data series held within the dataBag.
Property methods: seriesCountDisplayToLogical(), seriesCountGet(), seriesCountIsValid(), seriesCountLogicalToDisplay(), seriesCountLogicalToOdbc(), seriesCountNormalize(), seriesCountSet()
property seriesNames as %ZEN.Datatype.csv (XMLPROJECTION = "NONE") [ Private ];
List of data series names contained within this dataBag.
Property methods: seriesNamesDisplayToLogical(), seriesNamesGet(), seriesNamesIsValid(), seriesNamesLogicalToDisplay(), seriesNamesLogicalToOdbc(), seriesNamesNormalize(), seriesNamesSet()

Methods (Including Private)

method %Clear()
Delete data currently in the dataBag.
method %CopyFromModel(pModel As %ZEN.DataModel.DataModel) as %Status
Fill the contents of this dataBag from the given DataModel
method %CopyToModel(pModel As %ZEN.DataModel.DataModel) as %Status
Copy the contents of this dataBag into the given DataModel.
method %GetArray(Output pArray)
Copy the contents of this dataBag into a local array.
method %GetLabel(pProperty As %String) as %String
Get the label for a property within the dataBag.
method %GetType(pProperty As %String) as %String
Get the type of a property within the dataBag.
method %GetValue(pProperty As %String, pSeries As %Integer = 1) as %String
Get the value of a property within the dataBag.
Note that this can return a literal value, an object value (oref), or $$$ZENMISSING if the given property is not in the model.
method %OnDrawObjectProperties() as %Status
Called just before we serve property values to the client.
method %OnObjectSynch() as %Status
Make sure client data is prepared.
method %OnZENDeserialize() as %Status
Deserialize additional values from the client.
method %SerializeData(pDelim As %String = $C(5)) as %Status
Convert internal arrays to a serialized strings for use on the client.
method %SetValue(pProperty As %String, pValue As %String)