Home > Class Reference > ENSLIB namespace > EnsPortal.MsgFilter.Filter


serial class EnsPortal.MsgFilter.Filter extends %Library.SerialObject, %XML.Adaptor

Property Inventory

Method Inventory


parameter HEADERCLASS = Ens.MessageHeader;


property ColorBy as %String (VALUELIST = ",TimeCreated,SessionId,Status,Error,Source");
Not used in new portal at present, but stored from old portal.
Property methods: ColorByDisplayToLogical(), ColorByGet(), ColorByIsValid(), ColorByLogicalToDisplay(), ColorByLogicalToOdbc(), ColorByNormalize(), ColorBySet()
property EndId as %Integer;
End ID value
Property methods: EndIdDisplayToLogical(), EndIdGet(), EndIdIsValid(), EndIdLogicalToDisplay(), EndIdNormalize(), EndIdSet(), EndIdXSDToLogical()
property EndTime as %String;
End date/time
Property methods: EndTimeDisplayToLogical(), EndTimeGet(), EndTimeIsValid(), EndTimeLogicalToDisplay(), EndTimeLogicalToOdbc(), EndTimeNormalize(), EndTimeSet()
property GeneratedSQL as %String) [ Transient ];
SQL statement generated from the supplied criteria. This property is used by the UI to get the SQL statement.
Property methods: GeneratedSQLDisplayToLogical(), GeneratedSQLGet(), GeneratedSQLIsValid(), GeneratedSQLLogicalToDisplay(), GeneratedSQLLogicalToOdbc(), GeneratedSQLNormalize(), GeneratedSQLSet()
property IsError as %Integer;
Property methods: IsErrorDisplayToLogical(), IsErrorGet(), IsErrorIsValid(), IsErrorLogicalToDisplay(), IsErrorNormalize(), IsErrorSet(), IsErrorXSDToLogical()
property MaxRows as %Integer (MINVAL = 1);
Number of rows to display
Property methods: MaxRowsDisplayToLogical(), MaxRowsGet(), MaxRowsIsValid(), MaxRowsLogicalToDisplay(), MaxRowsNormalize(), MaxRowsSet(), MaxRowsXSDToLogical()
property SequenceManagerSearch as %String (VALUELIST = ",Dups,Gaps,Lates");
Special Sequence Manager-related searches.
Property methods: SequenceManagerSearchDisplayToLogical(), SequenceManagerSearchGet(), SequenceManagerSearchIsValid(), SequenceManagerSearchLogicalToDisplay(), SequenceManagerSearchLogicalToOdbc(), SequenceManagerSearchNormalize(), SequenceManagerSearchSet()
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/time
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 Target as %String (MAXLEN = 128);
Property methods: TargetDisplayToLogical(), TargetGet(), TargetIsValid(), TargetLogicalToDisplay(), TargetLogicalToOdbc(), TargetNormalize(), TargetSet()
property Terms as list of EnsPortal.MsgFilter.Term;
List of terms for this Filter.
Property methods: TermsBuildValueArray(), TermsCollectionToDisplay(), TermsCollectionToOdbc(), TermsDisplayToCollection(), TermsGet(), TermsGetObject(), TermsGetObjectId(), TermsGetSwizzled(), TermsIsValid(), TermsOdbcToCollection(), TermsSet(), TermsSetObject(), TermsSetObjectId()
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 [ Transient ];
Timeout to quit doing PostRS checks from within the query
Property methods: TimeoutDisplayToLogical(), TimeoutGet(), TimeoutIsValid(), TimeoutLogicalToDisplay(), TimeoutNormalize(), TimeoutSet(), TimeoutXSDToLogical()
property TopCount as %Integer;
Number of rows used in a TOP expression.
Property methods: TopCountDisplayToLogical(), TopCountGet(), TopCountIsValid(), TopCountLogicalToDisplay(), TopCountNormalize(), TopCountSet(), TopCountXSDToLogical()
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()


classmethod DeleteFromSession() as %Status
Remove the current saved Filter from the CSP session.
classmethod DeleteFromTemp(pKey As %Integer = 0) as %Status
Remove the Filter specified by pKey from CACHETEMP.
classmethod DeleteFromVirtualSession(ByRef pKey As %Integer) as %Status
Remove the Filter specified by pKey from CACHETEMP.
classmethod HasDefaultVals(pFilter As EnsPortal.MsgFilter.Filter) as %Boolean
classmethod LoadFromSession(Output pFilter As EnsPortal.MsgFilter.Filter) as %Status
Deserialise a Filter from the current CSP session, or create a new Filter object if no serialised data exists.
classmethod LoadFromTemp(pKey As %Integer = 0, Output pFilter As EnsPortal.MsgFilter.Filter) as %Status
Deserialise a Filter from CACHETEMP using the key supplied in pKey
classmethod LoadFromVirtualSession(ByRef pKey As %Integer, Output pFilter As EnsPortal.MsgFilter.Filter) as %Status
Deserialize a Filter from CACHETEMP using the key supplied in pKey.
method NextTerm(ByRef iTerm) as EnsPortal.MsgFilter.Term
Find the next valid term in the terms list, skipping over adjacent OR's and leading or trailing OR's
method SaveToSession() as %Status
Serialise the current Filter to the CSP session.
method SaveToTemp(Output pKey As %Integer) as %Status
Serialise the current Filter to CACHETEMP.
method SaveToVirtualSession(ByRef pKey As %Integer) as %Status
Saves the last search for the current browser tab (%session can be shared among browser windows so we use var>pKey to prevent unwanted mixup between browser windows). Serialize the current Filter to CACHETEMP.

Inherited Members

Inherited Methods