com.force.i18n.grammar

Interface RenamingProvider

public interface RenamingProvider

Interface for something that provides nouns that are renamed for the given request

Author:

stamm

Method Summary

Modifier and Type	Method and Description
boolean	displayMiddleNameInCalculatedPersonName()
boolean	displaySuffixInCalculatedPersonName()
Noun	getNoun(HumanLanguage language, Renameable key) Get a renamed noun for the given renameable, or the standard noun if there isn't a renamed noun for that object.
Noun	getPackagedNoun(HumanLanguage language, String key) Get the "original" noun for a non standard key, in case there is some other "standard" label for it
Noun	getRenamedNoun(HumanLanguage language, String key) Get a renamed "standard" noun
boolean	isCustomKey(String key)
boolean	isRenamed(HumanLanguage language, String key)
boolean	supportOldGrammarEngine() Grammar engine switched in 164
boolean	useRenamedNouns()

Method Detail

getRenamedNoun

Noun getRenamedNoun(HumanLanguage language,
                    String key)

Get a renamed "standard" noun

Parameters:

language - the language

key - the key for the "custom" entity.

Returns:

a noun for the given renameable, if it is renamed

getPackagedNoun

Noun getPackagedNoun(HumanLanguage language,
                     String key)

Get the "original" noun for a non standard key, in case there is some other "standard" label for it

Parameters:

language - the language

key - the key for the "custom" entity.

Returns:

a noun for the given renameable with the "original" values

getNoun

Noun getNoun(HumanLanguage language,
             Renameable key)

Get a renamed noun for the given renameable, or the standard noun if there isn't a renamed noun for that object. This is a convenience method for callers so that they don't have to do the fallthrough logic themselves

Parameters:

language - the language

key - the key for the "custom" entity.

Returns:

the noun for the given renameable, renamed if applicable

isRenamed

boolean isRenamed(HumanLanguage language,
                  String key)

Returns:

true if the noun identified by "key" is renamed in the given language

isCustomKey

boolean isCustomKey(String key)

Returns:

true if the noun identified by "key" is "custom"

useRenamedNouns

boolean useRenamedNouns()

Returns:

true if renaming should be checked for standard nouns (i.e. not)

supportOldGrammarEngine

boolean supportOldGrammarEngine()

Grammar engine switched in 164

Returns:

true if API version is less than 164

displayMiddleNameInCalculatedPersonName

boolean displayMiddleNameInCalculatedPersonName()

Returns:

true if the current User Context's Perm and Prefs allow them to see the Middle Name in calculated full people's names

displaySuffixInCalculatedPersonName

boolean displaySuffixInCalculatedPersonName()

Returns:

true if the current User Context's Perm and Prefs allow them to see the Suffix in calculated full people's names