intradoc.common
Interface SystemInterface

public interface SystemInterface

Method Summary

void	displayStatus(java.lang.String status)
java.lang.String	getAppName()
ExecutionContext	getExecutionContext()
java.awt.Frame	getMainWindow()
java.lang.String	getString(java.lang.String key) Using the current ExecutionContext, look up the l10n string associated with the key.
java.lang.String	getValidationErrorMessage(java.lang.String fieldName, java.lang.String fieldValue) Using the current ExecutionContext, look up the i18n message for an invalid value in a field.
java.lang.String	localizeCaption(java.lang.String key) Using the current ExecutionContext, look up the l10n string associated with the key and substitute it into syCaptionWrapper.
java.lang.String	localizeMessage(java.lang.String msg)

Method Detail

getMainWindow

public java.awt.Frame getMainWindow()

displayStatus

public void displayStatus(java.lang.String status)

getAppName

public java.lang.String getAppName()

getExecutionContext

public ExecutionContext getExecutionContext()

localizeMessage

public java.lang.String localizeMessage(java.lang.String msg)

localizeCaption

public java.lang.String localizeCaption(java.lang.String key)

Using the current ExecutionContext, look up the l10n string associated with the key and substitute it into syCaptionWrapper. In English, this will append a colon and a space. In other languages, the result may be different.

getString

public java.lang.String getString(java.lang.String key)

Using the current ExecutionContext, look up the l10n string associated with the key. Typically, this method will be implemented as the one liner: return LocaleResources.getString(key, getExecutionContext());

getValidationErrorMessage

public java.lang.String getValidationErrorMessage(java.lang.String fieldName,
                                                  java.lang.String fieldValue)

Using the current ExecutionContext, look up the i18n message for an invalid value in a field. This message is constructed by appending the name of the component to the key prefix "apInvalidValue_" and looking up that key. If it exists, LocaleUtils.encodeMessage() is used to encode the key, the field name, and the field value. Otherwise, null is returned.