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

Ens.Enterprise.Portal.MsgFilter.EnterpriseAssistant

class Ens.Enterprise.Portal.MsgFilter.EnterpriseAssistant extends EnsPortal.MsgFilter.Assistant

Method Inventory (Including Private)

Parameters

parameter FilterClass = Ens.Enterprise.Portal.MsgFilter.EnterpriseFilter;
Name of Filter to use for searches.

Methods (Including Private)

classmethod CreateFilter(pSearchCriteria As %ZEN.proxyObject, Output pFilter As Ens.Enterprise.Portal.MsgFilter.EnterpriseFilter, pExcludeSequenceManager As %Boolean = 1, pVirtualKey As %Integer = 0) as %Status
Callback to create the Filter class for this Assistant. The paging logic is implemented in this method based on the nextPageStartId and nextPageEndId properties of the supplied proxyObject.
classmethod CreateProxy(pFilter As Ens.Enterprise.Portal.MsgFilter.EnterpriseFilter, Output pSearchCriteria As %ZEN.proxyObject, pExcludeSequenceManager As %Boolean = 1) as %Status
Callback to create a Zen proxyObject from a supplied EnterpriseFilter.
classmethod EnumerateExecute(ByRef qHandle As %Binary, Filter As Ens.Enterprise.Portal.MsgFilter.EnterpriseFilter) as %Status
Inherited description: Initial method which parses the Filter into SQL terms and post-SQL terms. It then constructs an inner result set based on the SQL terms and calls the execute method of this inner result set.
classmethod EnumerateFetch(ByRef qHandle As %Binary, ByRef Row As %List, ByRef AtEnd As %Integer = 0) as %Status
Inherited description: Method which actually implements fetching of data. Note that the postSQLFilter()() method of the Assistant is called to allow for any virtual document filters to be applied to the result set.
classmethod EnumerateGetInfo(colinfo As %List, parminfo As %List, idinfo As %List, qHandle As %Binary, extoption As %Integer = 0, extinfo As %List) as %Status
Inherited description: Callback to get metadata about the results from the inner resultset created in the EnumerateExecute() method. The metadata is created dynamically to reflect the columns present in the result set.
classmethod EnumerateTempResultsExecute(ByRef qHandle As %Binary, Filter As Ens.Enterprise.Portal.MsgFilter.EnterpriseFilter) as %Status
classmethod EnumerateTempResultsFetch(ByRef qHandle As %Binary, ByRef Row As %List, ByRef AtEnd As %Integer = 0) as %Status
classmethod EnumerateTempResultsGetInfo(colinfo As %List, parminfo As %List, idinfo As %List, qHandle As %Binary, extoption As %Integer = 0, extinfo As %List) as %Status
private classmethod GetClassQueryInfo(pQueryName As %String = "Enumerate", colinfo As %List, parminfo As %List, idinfo As %List, qHandle As %Binary, extoption As %Integer = 0, extinfo As %List) as %Status
classmethod GetResultSet(pFilter As Ens.Enterprise.Portal.MsgFilter.EnterpriseFilter, Output pResultSet As %ResultSet, pExecute As %Boolean = 1) as %Status
Helper method to return a valid ResultSet for the supplied Filter object. The result set construction itself is wrapped by the Enumerate query. The main goal is to branch the Sequence Manager the logic in this method, but subclasses can implement any logic they see fit to create a result set object.
classmethod checkDisplayValues(pFilter As EnsPortal.MsgFilter.Filter) as %Boolean
Helper method to check whether the filter supplied in pFilter contains any Display values.
classmethod queryClient(pClientID As %String, pFilterString As %String, pSessionID As %String, pTempNode As %Integer, pTimeout As %Numeric = 5, pGetColInfo As %Boolean = 0, pVirtualKey As %Integer = 0)

Queries

query Enumerate(Filter As Ens.Enterprise.Portal.MsgFilter.EnterpriseFilter)
Selects System, ID, TimeCreated, Session, Status, Error, Source, Target
List the messages matching the given filter object.
query EnumerateTempResults(Filter As Ens.Enterprise.Portal.MsgFilter.EnterpriseFilter)
Selects System, ID, TimeCreated, Session, Status, Error, Source, Target

Inherited Members

Inherited Properties (Including Private)

Inherited Methods (Including Private)