com.xpn.xwiki.plugin.globalsearch
Class GlobalSearchMessageTool

java.lang.Object
  com.xpn.xwiki.web.XWikiMessageTool
      com.xpn.xwiki.plugin.applicationmanager.core.plugin.XWikiPluginMessageTool
          com.xpn.xwiki.plugin.globalsearch.GlobalSearchMessageTool

public class GlobalSearchMessageTool
extends XWikiPluginMessageTool

Global Search plugin translation messages manager.

The main use of this class is construct XWikiPluginMessageTool with the correct ResourceBundle and to list all the message keys used internally in the plugin.

Version:

$Id$

Field Summary

static java.lang.String	ERROR_CANTACCESSFIELD Used as GlobalSearchException message when provided field does not exist in the document.
static java.lang.String	ERROR_DOCUMENTTRANSLATIONS Used as GlobalSearchException message when failed to get document translations.
static java.lang.String	LOG_GETDOCUMENTFROMNAME Used as Log log message when trying to get document from name.
static java.lang.String	LOG_SEARCHDOCUMENTS Used as Log log message when trying to search documents.
static java.lang.String	MESSAGETOOL_CONTEXT_KEY Key to use with Hashtable.get(Object).

Fields inherited from class com.xpn.xwiki.web.XWikiMessageTool

bundle, BYTE_ENCODING, context

Method Summary

static GlobalSearchMessageTool

getDefault(XWikiContext context) Get Global Search message tool registered in XWiki context.

Methods inherited from class com.xpn.xwiki.plugin.applicationmanager.core.plugin.XWikiPluginMessageTool

get, get, getTranslation

Methods inherited from class com.xpn.xwiki.web.XWikiMessageTool

get, get, getDocumentBundle, getDocumentBundleNames, getDocumentBundleProperties, getDocumentBundles, getDocumentBundles

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

MESSAGETOOL_CONTEXT_KEY

public static final java.lang.String MESSAGETOOL_CONTEXT_KEY

Key to use with Hashtable.get(Object).

See Also:

Constant Field Values

ERROR_CANTACCESSFIELD

public static final java.lang.String ERROR_CANTACCESSFIELD

Used as GlobalSearchException message when provided field does not exist in the document.

See Also:

Constant Field Values

ERROR_DOCUMENTTRANSLATIONS

public static final java.lang.String ERROR_DOCUMENTTRANSLATIONS

Used as GlobalSearchException message when failed to get document translations.

See Also:

Constant Field Values

LOG_SEARCHDOCUMENTS

public static final java.lang.String LOG_SEARCHDOCUMENTS

Used as Log log message when trying to search documents.

See Also:

Constant Field Values

LOG_GETDOCUMENTFROMNAME

public static final java.lang.String LOG_GETDOCUMENTFROMNAME

Used as Log log message when trying to get document from name.

See Also:

Constant Field Values

Method Detail

getDefault

public static GlobalSearchMessageTool getDefault(XWikiContext context)

Get Global Search message tool registered in XWiki context. If not return default.

Parameters:

context - the XWiki context from which to get message tool.

Returns:

the default Global Search message tool.

Since:

1.1