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

Class VariablePresentation

java.lang.Object

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

All Implemented Interfaces:

IVariablePresentation

public class VariablePresentation
extends Object
implements IVariablePresentation

Default implementation for IVariablePresentation

Field Summary

Fields inherited from interface com.e1c.g5.v8.dt.lcore.ui.templates.contentassist.parsing.IVariablePresentation

ANY_LANGUAGE

Constructor Summary

Constructors

Constructor	Description
VariablePresentation(String ruName, String engName, String description, int parametersCount, List<String> acceptableLanguages)	Creates new instance of this with given parameters
VariablePresentation(String ruName, String engName, String description, int parametersCount, List<String> acceptableLanguages, List<String> suggestedNamesRu, List<String> suggestedNamesEn)	Creates new instance of this with given parameters
VariablePresentation(String ruName, String engName, String description, int parametersCount, List<String> acceptableLanguages, List<String> suggestedNamesRu, List<String> suggestedNamesEn, List<String[]> parameterProposalsRu, List<String[]> parameterProposalsEn)	Creates new instance of this with given parameters

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 russianLocale)	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.

Methods inherited from class java.lang.Object

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

Constructor Detail

VariablePresentation

public VariablePresentation(String ruName,
                            String engName,
                            String description,
                            int parametersCount,
                            List<String> acceptableLanguages)

Creates new instance of this with given parameters

Parameters:

ruName - Localized to russian name of the variable, cannot be null

engName - English version of the name of the variable, cannot be null

description - Human readable description of the variable, cannot be null

parametersCount - The amount of parameters

acceptableLanguages - The languages that this variable can be created for, cannot be null

VariablePresentation

public VariablePresentation(String ruName,
                            String engName,
                            String description,
                            int parametersCount,
                            List<String> acceptableLanguages,
                            List<String> suggestedNamesRu,
                            List<String> suggestedNamesEn)

Creates new instance of this with given parameters

Parameters:

ruName - Localized to russian name of the variable, cannot be null

engName - English version of the name of the variable, cannot be null

description - Human readable description of the variable, cannot be null

parametersCount - The amount of parameters

acceptableLanguages - The languages that this variable can be created for, cannot be null

suggestedNamesRu - The suggested names in Russian language for parameters, can be null

suggestedNamesEn - The suggested names in English language for parameters, can be null

VariablePresentation

public VariablePresentation(String ruName,
                            String engName,
                            String description,
                            int parametersCount,
                            List<String> acceptableLanguages,
                            List<String> suggestedNamesRu,
                            List<String> suggestedNamesEn,
                            List<String[]> parameterProposalsRu,
                            List<String[]> parameterProposalsEn)

Creates new instance of this with given parameters

Parameters:

ruName - Localized to russian name of the variable, cannot be null

engName - English version of the name of the variable, cannot be null

description - Human readable description of the variable, cannot be null

parametersCount - The amount of parameters

acceptableLanguages - The languages that this variable can be created for, cannot be null

suggestedNamesRu - The suggested names in Russian language for parameters, can be null

suggestedNamesEn - The suggested names in English language for parameters, can be null

parameterProposalsRu - proposals for each parameters in Russian language, can be null

parameterProposalsRu - proposals for each parameters in English language, can be null

Method Detail

getProposalsForParameters

public String[] getProposalsForParameters(int parameterIndex,
                                          boolean isRu)

Description copied from interface: IVariablePresentation

Gets proposals for variable parameter

Specified by:

getProposalsForParameters in interface IVariablePresentation

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

getName

public String getName(boolean russianLocale)

Description copied from interface: IVariablePresentation

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

Specified by:

getName in interface IVariablePresentation

Returns:

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

getAcceptableLanguages

public List<String> getAcceptableLanguages()

Description copied from interface: IVariablePresentation

Returns the language that this variable belongs to

Specified by:

getAcceptableLanguages in interface IVariablePresentation

Returns:

The the language of this variable, cannot be null

getDescription

public String getDescription()

Description copied from interface: IVariablePresentation

The description of the variable

Specified by:

getDescription in interface IVariablePresentation

Returns:

The description of the variable, cannot be null

getParametersCount

public int getParametersCount()

Description copied from interface: IVariablePresentation

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

Specified by:

getParametersCount in interface IVariablePresentation

Returns:

The number of parameters held by this variable

getSuggestedParameterNames

public List<String> getSuggestedParameterNames(boolean isRu)

Description copied from interface: IVariablePresentation

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 IVariablePresentation.getParametersCount()

Specified by:

getSuggestedParameterNames in interface IVariablePresentation

Returns:

The list of localized names for parameters, can be null