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


serial class Ens.Enterprise.Portal.MsgFilter.Filter extends EnsPortal.MsgFilter.Filter

Property Inventory (Including Private)

Method Inventory (Including Private)


parameter HEADERCLASS = Ens.Enterprise.MsgBank.MessageHeader;
parameter XMLTYPE = MsgBankFilter;
Inherited description: This parameter provides the default XMLTYPE for the class. If it is empty then the class name will be used to construct a default XML type. The default XMLTYPE is used when naming and referencing this type in a schema and the schema context did not provide an XML type name.

Properties (Including Private)

property ClientIDs as list of %String);
List of client systems to restrict a search to.
Property methods: ClientIDsBuildValueArray(), ClientIDsCollectionToDisplay(), ClientIDsCollectionToOdbc(), ClientIDsDisplayToCollection(), ClientIDsDisplayToLogical(), ClientIDsGet(), ClientIDsGetObject(), ClientIDsGetObjectId(), ClientIDsGetSwizzled(), ClientIDsIsValid(), ClientIDsLogicalToDisplay(), ClientIDsLogicalToOdbc(), ClientIDsNormalize(), ClientIDsOdbcToCollection(), ClientIDsSet(), ClientIDsSetObject(), ClientIDsSetObjectId()

Methods (Including Private)

classmethod DeleteFromSession() as %Status [ Language = objectscript ]
Remove the current saved Filter from the CSP session.
classmethod DeleteFromVirtualSession(ByRef pKey As %Integer) as %Status [ Language = objectscript ]
Remove the Filter specified by pKey from IRISTEMP.
classmethod HasDefaultVals(pFilter As Ens.Enterprise.Portal.MsgFilter.Filter) as %Boolean [ Language = objectscript ]
classmethod LoadFromSession(Output pFilter As EnsPortal.MsgFilter.Filter) as %Status [ Language = objectscript ]
Deserialise a Filter from the current CSP session, or create a new Filter object if no serialised data exists.
classmethod LoadFromVirtualSession(ByRef pKey As %Integer, Output pFilter As EnsPortal.MsgFilter.Filter) as %Status [ Language = objectscript ]
Deserialize a Filter from IRISTEMP using the key supplied in pKey.
method SaveToSession() as %Status [ Language = objectscript ]
Serialise the current Filter to the CSP session.
method SaveToVirtualSession(ByRef pKey As %Integer) as %Status [ Language = objectscript ]
Set property searchIdentifier to the corresponding location pKey, if not set yet. Serialize the current Filter to IRISTEMP.

Inherited Members

Inherited Properties (Including Private)

Inherited Methods (Including Private)