Skip to main content

Ens.Message.SavedSearch

persistent class Ens.Message.SavedSearch extends %Library.Persistent, Ens.Message.SearchBase

SQL Table Name: Ens_Message.SavedSearch

Saved message searches

Property Inventory

Method Inventory

Properties

property Name as %String) [ Required ];
Property methods: NameDisplayToLogical(), NameGet(), NameGetStored(), NameIsValid(), NameLogicalToDisplay(), NameLogicalToOdbc(), NameNormalize(), NameSet()

Methods

method %OnNew(criteria As %DynamicObject = {{}}, orderAsc As %Boolean = 0, name As %String = "") as %Status
Inherited description: This callback method is invoked by the %New() method to provide notification that a new instance of an object is being created.

If this method returns an error then the object will not be created.

It is passed the arguments provided in the %New call. When customizing this method, override the arguments with whatever variables and types you expect to receive from %New(). For example, if you're going to call %New, passing 2 arguments, %OnNew's signature could be:

Method %OnNew(dob as %Date = "", name as %Name = "") as %Status If instead of returning a %Status code this returns an oref and this oref is a subclass of the current class then this oref will be the one returned to the caller of %New method.

classmethod Create(name As %String = "", criteria As %DynamicObject = {{}}, orderAsc As %Boolean = 0) as %Status
Creates a new saved search
classmethod Delete(name As %String) as %Status
Deletes the saved search named name
classmethod GetAll() as %DynamicArray
Gets all saved searches in alphabetical order
classmethod Rename(name As %String = "", newName As %String) as %Status
Renames the saved search named name to newName
classmethod SaveAs(name As %String = "", newName As %String) as %Status
Creates a copy of the saved search named name and saves it under newName
classmethod Update(name As %String, criteria As %DynamicObject, orderAsc As %Boolean) as %Status
Updates the saved search named name with new criteria or order

Indexes

index (IdKey on Username,Name) [IdKey, Type = key];
Index methods: IdKeyCheck(), IdKeyDelete(), IdKeyExists(), IdKeyOpen(), IdKeySQLCheckUnique(), IdKeySQLExists(), IdKeySQLFindPKeyByConstraint(), IdKeySQLFindRowIDByConstraint()

Inherited Members

Inherited Properties

Inherited Methods

Storage

Storage Model: Storage (Ens.Message.SavedSearch)

^Ens.Message.SavedSearchD(ID,"Criteria")
=
Criteria

Storage Model: Storage (Ens.Message.SavedSearch)

^Ens.Message.SavedSearchD(ID)
=
%%CLASSNAME
Name
OrderAsc
Username
FeedbackOpens in a new tab