Skip to main content


serial class HS.Push.Types.FilterSerialInfo extends %Library.SerialObject, %XML.Adaptor

Used for passing information about detail filters as part of SubscriptionSerialInfo

Property Inventory


Inherited description: The XMLIGNOREINVALIDTAG parameter allows the programmer to control handling of unexpected elements in the XML input. The XMLIGNOREINVALIDTAG parameter will only take affect if XMLSEQUENCE = 0 (the default). By default (XMLIGNOREINVALIDTAG = 0), will treat an unexpected element as an error. If XMLIGNOREINVALIDTAG is set = 1 and XMLSEQUENCE = 0, then unexpected elements will be ignored.
parameter XMLIGNORENULL = inputonly;
Inherited description: XMLIGNORENULL allows the programmer to override the default XML handling of empty strings for properties of type %String. By default (XMLIGNORENULL = 0), empty strings in the XML input are stored as $c(0) and $c(0) is written to XML as an empty tag. A missing tag in the XML input is always stored as "" and "" is always output to XML as no tag.

If XMLIGNORENULL is set = 1, then both missing tags in the XML and empty strings are input as "", and both "" and $c(0) are output as empty tags (i.e. <tag></tag>).

If XMLIGNORENULL is set = "inputonly", then both missing tags in the XML and empty strings are input as "". Output of "" and $c(0) are for XMLIGNORENULL = 0: $c(0) is output as an empty tag (i.e. <tag></tag>) and "" is output as no tag.

If XMLIGNORENULL = "runtime" (runtime is not case sensitive), then the behavior of XMLIGNORENULL is determined by the format parameter of XMLExport, XMLImport and %XML.Reader.OpenFile. The default behavior for XMLIGNORENULL="runtime is the same as XMLIGNORENULL=0. Adding "ignorenull" to the format argument changes the behavior to that of XMLIGNORENULL=1. "ignorenull" shoud be separated by a comma from literal/encoded part of the format. Example values for format are "", ",ignorenull", "literal,ignorenull" and "encoded,ignorenull". Note that "inputonly" is equivalent to using ,ignorenull for XMLExport and not for %XML.Reader.


property Context as %String (MAXLEN = 500);
XPath context for the expression
Property methods: ContextDisplayToLogical(), ContextGet(), ContextIsValid(), ContextLogicalToDisplay(), ContextLogicalToOdbc(), ContextNormalize(), ContextSet()
property CustomMethod as %String;
Name of the method to use for a custom filter (in the custom class in the \Push\Filter\Custom setting in HS.Registry.Config
Property methods: CustomMethodDisplayToLogical(), CustomMethodGet(), CustomMethodIsValid(), CustomMethodLogicalToDisplay(), CustomMethodLogicalToOdbc(), CustomMethodNormalize(), CustomMethodSet()
property Name as %String;
Name of filter
Property methods: NameDisplayToLogical(), NameGet(), NameIsValid(), NameLogicalToDisplay(), NameLogicalToOdbc(), NameNormalize(), NameSet()
property Operator as %String (DISPLAYLIST = ",Contains,Custom,Equals,Exists,Greater Than,In,Less Than,Starts With,Not Contain,Not Equal,Not Exist,Not Greater Than,Not In,Not Less Than,Not Start With", VALUELIST = ",CON,CUS,EQ,EX,GT,IN,LT,ST,NCN,NEQ,NEX,NGT,NIN,NLT,NST");
The operator to be used in the filter
Property methods: OperatorDisplayToLogical(), OperatorGet(), OperatorIsValid(), OperatorLogicalToDisplay(), OperatorLogicalToOdbc(), OperatorNormalize(), OperatorSet()
property Parameters as list of %String (MAXLEN = 256);
Names of parameters to be filled into the XPath expression of the filter or compared against the result
Property methods: ParametersBuildValueArray(), ParametersCollectionToDisplay(), ParametersCollectionToOdbc(), ParametersDisplayToCollection(), ParametersDisplayToLogical(), ParametersGet(), ParametersGetObject(), ParametersGetObjectId(), ParametersGetSwizzled(), ParametersIsValid(), ParametersLogicalToDisplay(), ParametersLogicalToOdbc(), ParametersNormalize(), ParametersOdbcToCollection(), ParametersSet(), ParametersSetObject(), ParametersSetObjectId()
property QueryColumn as %String (MAXLEN = 500);
The result column to evaluate
Property methods: QueryColumnDisplayToLogical(), QueryColumnGet(), QueryColumnIsValid(), QueryColumnLogicalToDisplay(), QueryColumnLogicalToOdbc(), QueryColumnNormalize(), QueryColumnSet()
property QueryCustomClass as %String (MAXLEN = 256);
The class name if the operator is custom
Property methods: QueryCustomClassDisplayToLogical(), QueryCustomClassGet(), QueryCustomClassIsValid(), QueryCustomClassLogicalToDisplay(), QueryCustomClassLogicalToOdbc(), QueryCustomClassNormalize(), QueryCustomClassSet()
property QueryCustomMethod as %String (MAXLEN = 256);
The method name if the operator is custom
Property methods: QueryCustomMethodDisplayToLogical(), QueryCustomMethodGet(), QueryCustomMethodIsValid(), QueryCustomMethodLogicalToDisplay(), QueryCustomMethodLogicalToOdbc(), QueryCustomMethodNormalize(), QueryCustomMethodSet()
property QueryName as %String (MAXLEN = 256);
Name of the query registry item to run
Property methods: QueryNameDisplayToLogical(), QueryNameGet(), QueryNameIsValid(), QueryNameLogicalToDisplay(), QueryNameLogicalToOdbc(), QueryNameNormalize(), QueryNameSet()
property QueryOperator as HS.Types.Grid.Operator;
The operator to apply to the result
Property methods: QueryOperatorDisplayToLogical(), QueryOperatorGet(), QueryOperatorIsValid(), QueryOperatorLogicalToDisplay(), QueryOperatorLogicalToOdbc(), QueryOperatorNormalize(), QueryOperatorSet()
property QueryParameterNames as list of %String (MAXLEN = 256);
List of query parameter names, parallel to the values list
Property methods: QueryParameterNamesBuildValueArray(), QueryParameterNamesCollectionToDisplay(), QueryParameterNamesCollectionToOdbc(), QueryParameterNamesDisplayToCollection(), QueryParameterNamesDisplayToLogical(), QueryParameterNamesGet(), QueryParameterNamesGetObject(), QueryParameterNamesGetObjectId(), QueryParameterNamesGetSwizzled(), QueryParameterNamesIsValid(), QueryParameterNamesLogicalToDisplay(), QueryParameterNamesLogicalToOdbc(), QueryParameterNamesNormalize(), QueryParameterNamesOdbcToCollection(), QueryParameterNamesSet(), QueryParameterNamesSetObject(), QueryParameterNamesSetObjectId()
property QueryParameterValues as list of %String (MAXLEN = 256);
List of query parameter values, parallel to the names list
Property methods: QueryParameterValuesBuildValueArray(), QueryParameterValuesCollectionToDisplay(), QueryParameterValuesCollectionToOdbc(), QueryParameterValuesDisplayToCollection(), QueryParameterValuesDisplayToLogical(), QueryParameterValuesGet(), QueryParameterValuesGetObject(), QueryParameterValuesGetObjectId(), QueryParameterValuesGetSwizzled(), QueryParameterValuesIsValid(), QueryParameterValuesLogicalToDisplay(), QueryParameterValuesLogicalToOdbc(), QueryParameterValuesNormalize(), QueryParameterValuesOdbcToCollection(), QueryParameterValuesSet(), QueryParameterValuesSetObject(), QueryParameterValuesSetObjectId()
property QueryResultMaximum as %Integer;
The maximum count for 'true' result evaluations
Property methods: QueryResultMaximumDisplayToLogical(), QueryResultMaximumGet(), QueryResultMaximumIsValid(), QueryResultMaximumLogicalToDisplay(), QueryResultMaximumNormalize(), QueryResultMaximumSet(), QueryResultMaximumXSDToLogical()
property QueryResultMinimum as %Integer;
The minimum count for 'true' result evaluations
Property methods: QueryResultMinimumDisplayToLogical(), QueryResultMinimumGet(), QueryResultMinimumIsValid(), QueryResultMinimumLogicalToDisplay(), QueryResultMinimumNormalize(), QueryResultMinimumSet(), QueryResultMinimumXSDToLogical()
property QueryResultValue as %String (MAXLEN = 256);
The value for the result operator
Property methods: QueryResultValueDisplayToLogical(), QueryResultValueGet(), QueryResultValueIsValid(), QueryResultValueLogicalToDisplay(), QueryResultValueLogicalToOdbc(), QueryResultValueNormalize(), QueryResultValueSet()
property QueryRow as %String (MAXLEN = 500);
The result row to evaluate
Property methods: QueryRowDisplayToLogical(), QueryRowGet(), QueryRowIsValid(), QueryRowLogicalToDisplay(), QueryRowLogicalToOdbc(), QueryRowNormalize(), QueryRowSet()
property QueryService as %String (MAXLEN = 255);
Analytics service name to send the query to
Property methods: QueryServiceDisplayToLogical(), QueryServiceGet(), QueryServiceIsValid(), QueryServiceLogicalToDisplay(), QueryServiceLogicalToOdbc(), QueryServiceNormalize(), QueryServiceSet()
property QueryType as %String (DISPLAYLIST = ",Immediate,Transfer,Sync", VALUELIST = ",I,T,S");
When to execute the filter
Property methods: QueryTypeDisplayToLogical(), QueryTypeGet(), QueryTypeIsValid(), QueryTypeLogicalToDisplay(), QueryTypeLogicalToOdbc(), QueryTypeNormalize(), QueryTypeSet()
property XPathExpression as %String (MAXLEN = 500);
XPath expression to be applied to the SDA. May contain parameters expressed as %1, %2, etc.
Property methods: XPathExpressionDisplayToLogical(), XPathExpressionGet(), XPathExpressionIsValid(), XPathExpressionLogicalToDisplay(), XPathExpressionLogicalToOdbc(), XPathExpressionNormalize(), XPathExpressionSet()

Inherited Members

Inherited Methods

FeedbackOpens in a new tab