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 > EnsPortal.MsgFilter.SavedSearch


persistent class EnsPortal.MsgFilter.SavedSearch extends %Library.Persistent, EnsPortal.MsgFilter.SavedSearchBase

SQL Table Name: EnsPortal_MsgFilter.SavedSearch

Class to implement Saved Searches in the Ensemble Management Portal. Its primary purpose is to provide a persistent wrapper around the EnsPortal.MsgFilter.Filter object used to construct Message Viewer searches.

Method Inventory (Including Private)

Methods (Including Private)

private method %OnAddToSaveSet(depth As %Integer = 3, insert As %Integer = 0, callcount As %Integer = 0) as %Status
Callback to update %TimeModified and %ModifiedBy.
classmethod ConvertAllCSPXSearches(Output pConverted As %Integer, Output pNotConverted As %Integer, pVerbose As %Integer = 1) as %Status
Utility method to convert instances of CSPX.EnsMsgFilterForm to instances of EnsPortal.MsgFilter.SavedSearch. The top node of pConverted reports the number of searches which were converted, and the names of the converted searches are inserted as subscripts of the array. pNotConverted reports the number of searches which were not converted in the same format as pConverted, but also indicates whether it was skipped (-1) or encountered an error, as per the pAction parameter returned from ConvertCSPXSearch()(). pVerbose indicates whether output should be logged to the current device. If pVerbose is greater than 1, the output will be indented pVerbose characters. (This is primarily for use by the Ensemble installation code.)
classmethod ConvertCSPXSearch(pSearchName As %String, Output pAction As %Integer, pVerbose As %Integer = 1) as %Status
Method to convert an instance of CSPX.EnsMsgFilterForm (as saved in the old Ensemble Management Portal), into an instance of EnsPortal.MsgFilter.SavedSearch, as used in the new Ensemble Management Portal. pSearchName - Name of CSPX.EnsMsgFilterForm instance to convert pAction returns 1 if successful, -1 if the named search already exists and 0 if there was some other error. pVerbose controls whether output is written to the current device. If larger than 1, the value will be used to indent the output.


index (Name on Name) [IdKey, Type = key];
Index methods: NameCheck(), NameDelete(), NameDisplayToLogical(), NameExists(), NameGet(), NameGetStored(), NameIsValid(), NameLogicalToDisplay(), NameLogicalToOdbc(), NameNormalize(), NameOpen(), NameSQLCheckUnique(), NameSQLExists(), NameSQLFindPKeyByConstraint(), NameSQLFindRowIDByConstraint(), NameSet()


trigger OnUpdate (BEFORE event INSERT/UPDATE);
Update %TimeModified and %ModifiedBy for SQL modifications.

Inherited Members

Inherited Properties (Including Private)

Inherited Methods (Including Private)


Storage Model: CacheStorage (EnsPortal.MsgFilter.SavedSearch)

FeedbackOpens in a new window