Package com.e1c.g5.v8.dt.lcore.ui.templates.contentassist.parsing

Interface IVariablePresentation

All Known Implementing Classes:

VariablePresentation

public interface IVariablePresentation

Presentation information about variable

Field Summary

Fields

Modifier and Type	Field	Description
static String	ANY_LANGUAGE	This string indicates that variable can be processed for any programming language

Method Summary

Modifier and Type	Method	Description
List<String>	getAcceptableLanguages()	Returns the language that this variable belongs to
String	getDescription()	The description of the variable
String	getName(boolean isRu)	Returns the name of this variable.
int	getParametersCount()	Returns the number representing the amount of parameters this variable shall have on the preference page proposal
String[]	getProposalsForParameters(int parameterIndex, boolean isRu)	Gets proposals for variable parameter
List<String>	getSuggestedParameterNames(boolean isRu)	Returns default localized names for parameters that will be used in proposal or null if there is no suggested parameters' names.

Field Detail

ANY_LANGUAGE

static final String ANY_LANGUAGE

This string indicates that variable can be processed for any programming language

See Also:

Constant Field Values

Method Detail

getName

String getName(boolean isRu)

Returns the name of this variable. It can have rus and eng representation

Parameters:

russianLocale - Whether the returned value shall be localized to russian

Returns:

The list of the names that is associated with this variable, cannot be null

getAcceptableLanguages

List<String> getAcceptableLanguages()

Returns the language that this variable belongs to

Returns:

The the language of this variable, cannot be null

getDescription

String getDescription()

The description of the variable

Parameters:

russianLocale - Whether the returned value shall be localized to russian

Returns:

The description of the variable, cannot be null

getParametersCount

int getParametersCount()

Returns the number representing the amount of parameters this variable shall have on the preference page proposal

Returns:

The number of parameters held by this variable

getSuggestedParameterNames

List<String> getSuggestedParameterNames(boolean isRu)

Returns default localized names for parameters that will be used in proposal or null if there is no suggested parameters' names. The list size shall be the size of getParametersCount()

Returns:

The list of localized names for parameters, can be null

getProposalsForParameters

String[] getProposalsForParameters(int parameterIndex,
                                   boolean isRu)

Gets proposals for variable parameter

Parameters:

parameterIndex - index of parameter, starts with 0

isRu - true if getting Russian language parameter proposals, false if getting English language parameter proposals

Returns:

proposals for variable parameter in concrete language Russian or English, never null