Inheritance diagram for AbstractPortal:

[legend]

Collaboration diagram for AbstractPortal:

Public Member Functions
_.Library.Status	BuildInfoPane ()
	Builds <xdata>infoPane</xdata>.

_.Library.Status	DrawFilter (_.Library.String pSeed)
	This method draws the filter in the filter popup screen.

_.Library.Status	EndSession ()
	Utility method to end the session from the client.

_.Library.Boolean	ExecuteQuery (_.Library.ResultSet pRS, _.Library.Status tSC, _.ZEN.Auxiliary.QueryInfo pInfo)
	Utility method to avoid executing queries when no domain is specified (which could lead to. More...

_.Library.Boolean	ExecuteQuerySys (_.Library.ResultSet pRS, _.Library.Status tSC, _.ZEN.Auxiliary.QueryInfo pInfo)
	Same as ExecuteQuery, but will use the system domain (ID=0) if ..source<0.

_.Library.Integer	GetCurrentFilterMode ()
	Returns the current filter mode, if any.

_.iKnow.Filters.Filter	GetCurrentFilterObject ()
	Returns the current filter object, if any.

_.Library.String	GetCurrentFilterString ()
	Returns the current filter string, if any. More...

_.Library.String	GetInfoPaneText ()
	Returns the text to be displayed in <xdata>infoPane</xdata>. More...

_.Library.Integer	GetPage (_.Library.String componentName)
	Utility method to return the "current page" stored in the session for the supplied component. More...

_.Library.Integer	GetSource ()
	Returns the currently selected source ID. More...

_.iKnow.Objects.Source	GetSourceObject ()
	Returns the currently selected source as a <class>iKnow.Objects.Source</class> or. More...

_.Library.Status	InitPages ()
	This method should to be implemented by subclasses using the paging functions, giving all paged. More...

_.Library.Integer	NextPage (_.Library.String componentName)
	Updates the current page for the supplied component to the next integer value.

_.Library.Status	OnChangeLanguageMode ()
	This method is called whenever the language mode changes, as part of <method>UpdateSource</method> More...

_.Library.Status	OnUpdateDomain (_.Library.Integer domainId)
	This method can be overridden at the subclass level to take any additional server-side. More...

_.Library.Status	OnUpdateSource (_.Library.Integer sourceId)
	Server-side method subclasses can override to take additional actions upon a change in the. More...

_.Library.Status	OnUpdateTerm (_.Library.String term)
	Server-side methods subclasses can override to take additional actions when the user selects. More...

_.Library.Integer	PreviousPage (_.Library.String componentName)
	Updates the current page for the supplied component to the previous integer value (minimum value is 1).

_.Library.Integer	ResetPages ()
	Resets all page information in the session.

_.Library.Status	UpdateDomain (_.Library.Integer domainId)
	ZenMethod to take appropriate cleanup action if the domain is updated. More...

_.Library.Status	UpdateSource (_.Library.Integer sourceId)
	Server-side method updating the source pointers and taking any other appropriate actions. More...

_.Library.Status	UpdateTerm (_.Library.String term)
	ZenMethod taking appropriate server-side cleanup and update actions when a new term is selected. More...

	drillFilterClient (filterString)
	Client-side method called when the "drill" link next to a filter (in VIEW mode) is clicked.

_.Library.Status	nextPageClient (componentName)
	Client-side method to trigger a components query to be re-executed for the next page of results.

	onTermKeyUp ()
	Key capture method to trigger <method>updateTermClient</method> when the enter key is pressed.

	onUpdateFilterClient ()
	Client-side method subclasses can override to execute additional logic when the user has changed. More...

	onUpdateSourceClient (source)
	Client-side method subclasses can override to take additional actions upon a change in the. More...

	onUpdateTermClient (term)
	Client-side method subclasses can override to take additional actions when the user selects. More...

_.Library.Status	previousPageClient (componentName)
	Client-side method to trigger a components query to be re-executed for the previous page of results.

	showFilterForm ()
	Display the filter popup window.

	updateFilterClient ()
	Client-side method called when the user commits his filter criteria in the filter popup window. More...

	updateSourceClient (source)
	Client-side method updating the source pointers and taking any other appropriate actions. More...

	updateTermClient (term)
	Client-side method to be called when the user selects a new term, which will call. More...

	useTermClient (term)
	Client-side method which will explicitly select a certain term, updating the txtTerm input field in. More...

Public Attributes
	domain
	More...

	filter
	More...

	filtermode
	More...

	languageMode
	More...

	skiplists
	More...

	source
	More...

	term
	More...

Static Public Attributes
	AUTONS = None
	If true, auto-switch namespace to whatever $NAMESPACE is passed in.

	RESOURCE = None
	All pages in <package>iKnow.UI</package> require at least the Development resource.

Private Member Functions
_.Library.Status	OnAfterCreatePage ()
	Initializes some of the panes and session variables used by this page, fetching domain,. More...

Detailed Description

This is the base class for the sample iKnow Portal pages, which is available to be subclassed by custom Zen pages exposing iKnow content and/or functionality. Some of the convenience services provided by this page include:

methods and widgets to select and manage a 'current' domain, source and term for the session, which can be used by queries and operations on this page.
a pane featuring a modalGroup widget for the user to specify a filter based on metadata criteria (showing all visible metadat fields for the current domain).
utility methods to page through results from iKnow queries.

Member Function Documentation

◆ OnAfterCreatePage()

_.Library.Status OnAfterCreatePage ( )

private

Initializes some of the panes and session variables used by this page, fetching domain,.

source and term variables from the request (if present). If certain activities need to be performed in a subclass, override <method>OnAfterCreatePage</method> rather than this method.

Reimplemented in MatchingResults.

◆ ExecuteQuery()

_.Library.Boolean ExecuteQuery	(	_.Library.ResultSet	pRS,
		_.Library.Status	tSC,
		_.ZEN.Auxiliary.QueryInfo	pInfo
	)

Utility method to avoid executing queries when no domain is specified (which could lead to.

noisy errors in the UI).

◆ GetCurrentFilterString()

_.Library.String GetCurrentFilterString ( )

Returns the current filter string, if any.

NOTE: this method is deprecated. Please access <property>filter</property> directly instead.

◆ GetInfoPaneText()

_.Library.String GetInfoPaneText ( )

Returns the text to be displayed in <xdata>infoPane</xdata>.

To be overridden by the subclass using it.

Reimplemented in MatchingResults, and IndexingResults.

◆ GetPage()

_.Library.Integer GetPage ( _.Library.String componentName )

Utility method to return the "current page" stored in the session for the supplied component.

name, or 1 if no page was registered so far.

◆ GetSource()

_.Library.Integer GetSource ( )

Returns the currently selected source ID.

NOTE: this method is deprecated. Please access <property>source</property> directly instead.

◆ GetSourceObject()

_.iKnow.Objects.Source GetSourceObject ( )

Returns the currently selected source as a <class>iKnow.Objects.Source</class> or.

<class>iKnow.Objects.VirtualSource</class> object.

◆ InitPages()

_.Library.Status InitPages ( )

This method should to be implemented by subclasses using the paging functions, giving all paged.

components a meaningful initial page value (usually 1).

◆ OnChangeLanguageMode()

_.Library.Status OnChangeLanguageMode ( )

This method is called whenever the language mode changes, as part of <method>UpdateSource</method>

or <method>OnAfterCreatePage</method>

Reimplemented in IndexingResults.

◆ OnUpdateDomain()

_.Library.Status OnUpdateDomain ( _.Library.Integer domainId )

This method can be overridden at the subclass level to take any additional server-side.

actions when the domain is changed.

Reimplemented in MatchingResults, and IndexingResults.

◆ OnUpdateSource()

_.Library.Status OnUpdateSource ( _.Library.Integer sourceId )

Server-side method subclasses can override to take additional actions upon a change in the.

current source.

Reimplemented in MatchingResults, and IndexingResults.

◆ OnUpdateTerm()

_.Library.Status OnUpdateTerm ( _.Library.String term )

Server-side methods subclasses can override to take additional actions when the user selects.

a new term.

◆ UpdateDomain()

_.Library.Status UpdateDomain ( _.Library.Integer domainId )

ZenMethod to take appropriate cleanup action if the domain is updated.

Will in turn call

<method>OnUpdateDomain</method>, which can be overridden by subclasses.

◆ UpdateSource()

_.Library.Status UpdateSource ( _.Library.Integer sourceId )

Server-side method updating the source pointers and taking any other appropriate actions.

Invokes

<method>OnUpdateSource</method> afterwards.

◆ UpdateTerm()

_.Library.Status UpdateTerm ( _.Library.String term )

ZenMethod taking appropriate server-side cleanup and update actions when a new term is selected.

Calls <method>OnUpdateTerm</method> afterwards.

◆ onUpdateFilterClient()

onUpdateFilterClient ( )

Client-side method subclasses can override to execute additional logic when the user has changed.

filter criteria.

◆ onUpdateSourceClient()

onUpdateSourceClient ( source )

Client-side method subclasses can override to take additional actions upon a change in the.

current source.

Reimplemented in IndexingResults.

◆ onUpdateTermClient()

onUpdateTermClient ( term )

Client-side method subclasses can override to take additional actions when the user selects.

a new term.

◆ updateFilterClient()

updateFilterClient ( )

Client-side method called when the user commits his filter criteria in the filter popup window.

This will call <method>OnUpdateFilter</method> on the server, close the popup and call <method>onUpdateFilterClient</method> afterwards.

◆ updateSourceClient()

updateSourceClient ( source )

Client-side method updating the source pointers and taking any other appropriate actions.

In turn

invokes <method>Updatesource</method> and <method>onUpdateSourceClient</method>.

◆ updateTermClient()

updateTermClient ( term )

Client-side method to be called when the user selects a new term, which will call.

<method>UpdateTerm</method> and <method>onUpdateTermClient</method>.

◆ useTermClient()

useTermClient ( term )

Client-side method which will explicitly select a certain term, updating the txtTerm input field in.

<xdata>txtTermPane</xdata> and then call <method>updateTermClient</method>.

Member Data Documentation

◆ domain

domain

◆ filter

filter

◆ filtermode

filtermode

◆ languageMode

languageMode

◆ skiplists

skiplists

◆ source

source

◆ term

term

Public Member Functions

Public Attributes

Static Public Attributes

Private Member Functions

Detailed Description

Member Function Documentation

◆ OnAfterCreatePage()

◆ ExecuteQuery()

◆ GetCurrentFilterString()

◆ GetInfoPaneText()

◆ GetPage()

◆ GetSource()

◆ GetSourceObject()

◆ InitPages()

◆ OnChangeLanguageMode()

◆ OnUpdateDomain()

◆ OnUpdateSource()

◆ OnUpdateTerm()

◆ UpdateDomain()

◆ UpdateSource()

◆ UpdateTerm()

◆ onUpdateFilterClient()

◆ onUpdateSourceClient()

◆ onUpdateTermClient()

◆ updateFilterClient()

◆ updateSourceClient()

◆ updateTermClient()

◆ useTermClient()

Member Data Documentation

◆ domain

◆ filter

◆ filtermode

◆ languageMode

◆ skiplists

◆ source

◆ term