Home > Class Reference > ENSLIB namespace > Ens.Enterprise.Portal.EnterpriseSearch


class Ens.Enterprise.Portal.EnterpriseSearch extends EnsPortal.Template.filteredViewer, Ens.Enterprise.Portal.base

Property Inventory (Including Private)

Method Inventory (Including Private)


parameter CANCANCELSEARCH = 1;
Indicate if can cancel search. This defines whether tempPortalNode is set.
parameter PAGENAME = Enterprise Message Viewer;
Inherited description: Name of this page.
parameter RESOURCE = %Ens_MsgBank_MessageHeader:USE;
User needs USE permissions on the %Ens_MsgBank_MessageHeader resource to view this page.
Indicate if ought to create tempPortalNode when page created. Used by Cancel feature for example.
parameter SessionSubscripts = Enterprise,SavedSearch;
Comma separated list of subscripts to use in the %session object for saved searches.

Properties (Including Private)

property %Clients as array of Ens.Enterprise.MonitorClient;
Property methods: %ClientsBuildValueArray(), %ClientsCollectionToDisplay(), %ClientsCollectionToOdbc(), %ClientsDisplayToCollection(), %ClientsGet(), %ClientsGetObject(), %ClientsGetObjectId(), %ClientsGetSwizzled(), %ClientsIsValid(), %ClientsOdbcToCollection(), %ClientsSet(), %ClientsSetObject(), %ClientsSetObjectId()
property assistantClass as %String [ InitialExpression = ..GetAssistantClass() , ReadOnly ];
Name of the Assistant class to use.
Property methods: assistantClassDisplayToLogical(), assistantClassGet(), assistantClassIsValid(), assistantClassLogicalToDisplay(), assistantClassLogicalToOdbc(), assistantClassNormalize()
property filterClass as %String [ InitialExpression = "Ens.Enterprise.Portal.MsgFilter.EnterpriseFilter" , ReadOnly ];
Name of Filter class to use for filtering searches.
Property methods: filterClassDisplayToLogical(), filterClassGet(), filterClassIsValid(), filterClassLogicalToDisplay(), filterClassLogicalToOdbc(), filterClassNormalize()
property savedSearchClass as %String [ InitialExpression = "Ens.Enterprise.Portal.MsgFilter.SavedEnterpriseSearch" , ReadOnly ];
Name of SavedSearch class to use for saving searches.
Property methods: savedSearchClassDisplayToLogical(), savedSearchClassGet(), savedSearchClassIsValid(), savedSearchClassLogicalToDisplay(), savedSearchClassLogicalToOdbc(), savedSearchClassNormalize()

Methods (Including Private)

method %OnAfterCreatePage() as %Status
Show/hide the toggle buttons
method %OnGetPageName() as %String
Get the (localized) name of the page.
method %OnGetTitle() as %String
Get the (localized) title string for the page.
method CreateResultSet(Output pSC As %Status, pInfo As %ZEN.Auxiliary.QueryInfo) as %ResultSet
Create and execute the result set used to drive the results table. Note that ignoreSearchWarnings controls whether the warnings in searchWarnings should be displayed to the user or ignored.
method DrawSessionCell(table As %ZEN.Component.tablePane, name As %ZEN.Datatype.string, seed As %ZEN.Datatype.string) as %Status
Server-side method to write out the content for the SessionId cells. The main purpose is to include a link to the trace on the client system when the session ID is known.
method DrawSystemCell(table As %ZEN.Component.tablePane, name As %ZEN.Datatype.string, seed As %ZEN.Datatype.string) as %Status
Draw the name of the client system, and include a link to the Message Viewer page on the current client.
method DrawTimeCreated(pTable As %ZEN.Component.tablePane, pName As %String, pSeed As %String) as %Status
Draw the TimeCreated HTML using an embedded tag to ensure that the full timestamp is always available to the client code for paging purposes.
method DrawWarnings(pTempNode As %String) as %Status
Method to draw the contents of warningsDiv in the output for a supplied temp node. If the temp node doesn't exist, or there are no errors, nothing is drawn.
classmethod GetAssistantClass() as %String
method LoadFilter(ByRef pParms, Output pObject As Ens.Enterprise.Portal.MsgFilter.EnterpriseFilter) as %Status
Load Filter object from the session, or from a saved search if requested.
method OnGetRibbonInfo(Output pDisplay As %Boolean, Output pViewIcons As %List, Output pSortOptions As %List, Output pSearchBox As %Boolean, Output pRibbonTitle As %String, Output pCommands As %List) as %Status
Get information to display in the ribbon bar.
clientmethod checkForSearchErrors() [ Language = javascript ]