SQL-HELP-002: Retrieve all help text entries for an application¶

This statement retrieves every help-text record (reference-key description and help-text body) belonging to a given application code. It is the retrieval query behind clsHelpTextCollection.GetHelpTexts, used to bulk-load all help-text entries for an application (e.g., prefetch/cache for HoverHelp controls).

Classification¶

Field	Value
SQL ID	SQL-HELP-002
Operation type	Read
Execution method	Inline SQL
Database	Oracle* — inferred from colon-prefixed bind-variable syntax; not directly confirmed
Schema	`[unqualified]**`
Command type	Text
Business object	`clsHelpTextCollection`
Criteria property	`RetrieveSQL`
Lifecycle method	`BeforeRetrieve` / `AfterRetrieve`

Parameters¶

Parameter	Direction	Type	Max length	Description
`:ApplicationCode`	Input	String	5	Application code identifying which application's help-text entries to retrieve

Tables¶

Table	Access	Columns used
APPLICATION_HELP_MASTER	JOIN / SELECT	`APPLICATION_CODE`, `REFERENCE_KEY_DESCR`, `REFERENCE_KEY_VALUE`
APPLICATION_HELP_DETAIL	JOIN / SELECT	`HELP_TEXT`, `REFERENCE_KEY_VALUE`

Sample SQL¶

SELECT
  APPLICATION_HELP_MASTER.APPLICATION_CODE as ApplicationCode,
  APPLICATION_HELP_MASTER.REFERENCE_KEY_DESCR as ReferenceKeyDescription,
  APPLICATION_HELP_MASTER.REFERENCE_KEY_VALUE as ReferenceKeyValue,
  APPLICATION_HELP_DETAIL.HELP_TEXT as HelpText
FROM
  APPLICATION_HELP_MASTER,
  APPLICATION_HELP_DETAIL
WHERE
  APPLICATION_HELP_MASTER.REFERENCE_KEY_VALUE = APPLICATION_HELP_DETAIL.REFERENCE_KEY_VALUE
  AND APPLICATION_HELP_MASTER.APPLICATION_CODE = :ApplicationCode

Operations and processes¶

Retrieve all help text entries for an application

Note: Statements marked with * were inferred from code structure, naming conventions, or contextual evidence where direct confirmation was not available in source artifacts. Statements marked with ** could not be confirmed; treat as unknown until verified.

Sources¶

SAIF.Presentation.Web.Controls.AJAX.Infragistics103\clsHelpTextCollection.vb