This is documentation for Caché & Ensemble.

For information on converting to InterSystems IRIS, see the InterSystems IRIS Adoption Guide and the InterSystems IRIS In-Place Conversion Guide, both available on the WRC Distributions page (login required).

Home > Class Reference > ENSLIB namespace > Ens.Enterprise.Portal.MsgFilter.LegacyFilter


class Ens.Enterprise.Portal.MsgFilter.LegacyFilter extends %Library.RegisteredObject, %XML.Adaptor

Helper class to allow Enterprise Message Search to serialise and deserialize XML to and from systems using CSPX.EnsMsgFilterForm to drive message searches.

Property Inventory

Method Inventory


parameter XMLNAME = MsgFilter;
Inherited description: This parameter provides the default XMLNAME for the class. If it is empty then the class name will be used to construct a default XML name. The default XMLNAME is used as the top level tag when exporting objects and the export context did not provide an XML container name.


property ColorBy as %String (VALUELIST = ",TimeCreated,SessionId,Status,Error,Source");
Column to color results by
Property methods: ColorByDisplayToLogical(), ColorByGet(), ColorByIsValid(), ColorByLogicalToDisplay(), ColorByLogicalToOdbc(), ColorByNormalize(), ColorBySet()
property Description as %String (MAXLEN = 2000, XMLNAME = "description", XMLPROJECTION = "element");
Property methods: DescriptionDisplayToLogical(), DescriptionGet(), DescriptionIsValid(), DescriptionLogicalToDisplay(), DescriptionLogicalToOdbc(), DescriptionNormalize(), DescriptionSet()
property EndId as %Integer;
End ID value
Property methods: EndIdDisplayToLogical(), EndIdGet(), EndIdIsValid(), EndIdLogicalToDisplay(), EndIdNormalize(), EndIdSet(), EndIdXSDToLogical()
property EndTime as %String;
End date
Property methods: EndTimeDisplayToLogical(), EndTimeGet(), EndTimeIsValid(), EndTimeLogicalToDisplay(), EndTimeLogicalToOdbc(), EndTimeNormalize(), EndTimeSet()
property IsError as %String (DISPLAYLIST = ",false,true", VALUELIST = ",0,1");
Property methods: IsErrorDisplayToLogical(), IsErrorGet(), IsErrorIsValid(), IsErrorLogicalToDisplay(), IsErrorLogicalToOdbc(), IsErrorNormalize(), IsErrorSet()
property MaxRows as %Integer (MINVAL = 1);
Number of rows to display
Property methods: MaxRowsDisplayToLogical(), MaxRowsGet(), MaxRowsIsValid(), MaxRowsLogicalToDisplay(), MaxRowsNormalize(), MaxRowsSet(), MaxRowsXSDToLogical()
property Name as %String (MAXLEN = 128, XMLPROJECTION = "attribute") [ Required ];
Property methods: NameDisplayToLogical(), NameGet(), NameIsValid(), NameLogicalToDisplay(), NameLogicalToOdbc(), NameNormalize(), NameSet()
property RuntimeMode as %String [ InitialExpression = 2 ];
Runtime mode to use (controls use of Logical/ODBC/Display values)
Property methods: RuntimeModeDisplayToLogical(), RuntimeModeGet(), RuntimeModeIsValid(), RuntimeModeLogicalToDisplay(), RuntimeModeLogicalToOdbc(), RuntimeModeNormalize(), RuntimeModeSet()
property SortOrder as %String (DISPLAYLIST = ",Oldest First,Newest First", VALUELIST = ",1,2") [ InitialExpression = 2 ];
How to sort data
Property methods: SortOrderDisplayToLogical(), SortOrderGet(), SortOrderIsValid(), SortOrderLogicalToDisplay(), SortOrderLogicalToOdbc(), SortOrderNormalize(), SortOrderSet()
property Source as %String (MAXLEN = 128);
Property methods: SourceDisplayToLogical(), SourceGet(), SourceIsValid(), SourceLogicalToDisplay(), SourceLogicalToOdbc(), SourceNormalize(), SourceSet()
property StartId as %Integer;
Starting ID value
Property methods: StartIdDisplayToLogical(), StartIdGet(), StartIdIsValid(), StartIdLogicalToDisplay(), StartIdNormalize(), StartIdSet(), StartIdXSDToLogical()
property StartTime as %String;
Starting date
Property methods: StartTimeDisplayToLogical(), StartTimeGet(), StartTimeIsValid(), StartTimeLogicalToDisplay(), StartTimeLogicalToOdbc(), StartTimeNormalize(), StartTimeSet()
property Status as Ens.DataType.MessageStatus;
Message status
Property methods: StatusDisplayToLogical(), StatusGet(), StatusIsValid(), StatusLogicalToDisplay(), StatusNormalize(), StatusSet(), StatusXSDToLogical()
property Terms as list of EnsPortal.MsgFilter.Term (XMLNAME = "Term", XMLPROJECTION = "element");
Set of detailed condition terms in the MsgFilter.
Property methods: TermsBuildValueArray(), TermsCollectionToDisplay(), TermsCollectionToOdbc(), TermsDisplayToCollection(), TermsGet(), TermsGetObject(), TermsGetObjectId(), TermsGetSwizzled(), TermsIsValid(), TermsOdbcToCollection(), TermsSet(), TermsSetObject(), TermsSetObjectId(), TermsStrDisplayToLogical(), TermsStrGet(), TermsStrIsValid(), TermsStrLogicalToDisplay(), TermsStrLogicalToOdbc(), TermsStrNormalize(), TermsStrSet()
property TermsStr as %String) [ Transient ];
Serialized set of detailed condition terms from the filter info pane
Property methods: TermsStrDisplayToLogical(), TermsStrGet(), TermsStrIsValid(), TermsStrLogicalToDisplay(), TermsStrLogicalToOdbc(), TermsStrNormalize(), TermsStrSet()
property TimeFormat as %String (DISPLAYLIST = ",Time Only,Complete", VALUELIST = ",12,999") [ InitialExpression = 12 ];
Time format
Property methods: TimeFormatDisplayToLogical(), TimeFormatGet(), TimeFormatIsValid(), TimeFormatLogicalToDisplay(), TimeFormatLogicalToOdbc(), TimeFormatNormalize(), TimeFormatSet()
property Timeout as %Numeric;
Timeout to quit doing PostRS checks from within queries
Property methods: TimeoutDisplayToLogical(), TimeoutGet(), TimeoutIsValid(), TimeoutLogicalToDisplay(), TimeoutNormalize(), TimeoutSet(), TimeoutXSDToLogical()
property Type as %String (DISPLAYLIST = ",Session Start,Request,Response,All", VALUELIST = ",0,1,2,3") [ InitialExpression = 0 ];
Message types
Property methods: TypeDisplayToLogical(), TypeGet(), TypeIsValid(), TypeLogicalToDisplay(), TypeLogicalToOdbc(), TypeNormalize(), TypeSet()


method ConvertToNewFilter(Output pFilter As EnsPortal.MsgFilter.Filter) as %Status
classmethod CreateFromNewFilter(pFilter As EnsPortal.MsgFilter.Filter, Output pLegacyFilter As Ens.Enterprise.Portal.MsgFilter.LegacyFilter) as %Status

Inherited Members

Inherited Methods