com.sap.caf.eu.gp.co.api

Interface IGPConfigAttributeInfo

public interface IGPConfigAttributeInfo

Describes the definition of a configuration attribute. The configuration attribute types are defined as constants. A confguration attribute is identified by its technical name. It can have localized name and description. The configuration attribute can beoptional and provide a default String value. For a configuration attribute a set of option values could be defined. Each option value consists of a string value and localizable text. In this case the configuration attriute as treated as being of a enumerated type and the value are displayed with their localized texts as a drop-down menu.

Field Summary

static int	CONFIGPARAM_BASE_BOOLEAN Base Type: Boolean
static int	CONFIGPARAM_BASE_INT Base Type: Integer
static int	CONFIGPARAM_BASE_NUMERIC Base Type: Numeric
static int	CONFIGPARAM_BASE_STRING Base Type: String

Method Summary

IGPConfigAttributeValue	addOptionValue(String value, String key) Adds a new value option for this configuration attribute.
Collection	getConfigAttributeValues() Returns the configuration attribute values
String	getDefaultStringValue() Retutns the default string value of the configuration attribute
String	getDescriptionKey() Returns the key for the localized description of the configuration attribute.
String	getNameKey() Returns the key for the localized name of the configuration attribute.
String	getTechName() Returns the technical name of the configuration attribute
int	getType() Returns the type of the configuration attribute
boolean	isOptional() Returns the optional flag of the configuration attribute
void	setDefaultStringValue(String defaultValue) Specifies the defualt string value of the configuration attribute
void	setDescriptionKey(String descriptionKey) Sets the key for the localized description of the configuration parameter
void	setNameKey(String nameKey) Sets the key for the localized name of the configuration parameter
void	setOptional(boolean optional) Specifies the optional flag of the configuration attribute
void	setType(int type) Specifies the type of the configuration attribute

Field Detail

CONFIGPARAM_BASE_STRING

public static final int CONFIGPARAM_BASE_STRING

Base Type: String

See Also:

Constant Field Values

CONFIGPARAM_BASE_INT

public static final int CONFIGPARAM_BASE_INT

Base Type: Integer

See Also:

Constant Field Values

CONFIGPARAM_BASE_BOOLEAN

public static final int CONFIGPARAM_BASE_BOOLEAN

Base Type: Boolean

See Also:

Constant Field Values

CONFIGPARAM_BASE_NUMERIC

public static final int CONFIGPARAM_BASE_NUMERIC

Base Type: Numeric

See Also:

Constant Field Values

Method Detail

getType

public int getType()

Returns the type of the configuration attribute

Returns:

the type of the configuration attirbute

setType

public void setType(int type)

Specifies the type of the configuration attribute

Parameters:

type -

getDefaultStringValue

public String getDefaultStringValue()

Retutns the default string value of the configuration attribute

Returns:

the default string value of the configuartion attribute

setDefaultStringValue

public void setDefaultStringValue(String defaultValue)

Specifies the defualt string value of the configuration attribute

Parameters:

defaultValue -

isOptional

public boolean isOptional()

Returns the optional flag of the configuration attribute

Returns:

the optional flag of the configuration attribute

setOptional

public void setOptional(boolean optional)

Specifies the optional flag of the configuration attribute

Parameters:

optional - the optional flag of the configuration attribute

getTechName

public String getTechName()

Returns the technical name of the configuration attribute

Returns:

the technical name of the configuration attribute

getNameKey

public String getNameKey()

Returns the key for the localized name of the configuration attribute. The localized name is resolved through the resource accessor of the technical description

Returns:

the key for the localized name of the configuration paramter

getDescriptionKey

public String getDescriptionKey()

Returns the key for the localized description of the configuration attribute. The localized description is resolved through the resource accessor of the technical description

Returns:

the key for the localized description of the configuration paramter

setNameKey

public void setNameKey(String nameKey)

Sets the key for the localized name of the configuration parameter

Parameters:

nameKey - the key for the localized name of the configuration paramter

setDescriptionKey

public void setDescriptionKey(String descriptionKey)

Sets the key for the localized description of the configuration parameter

Parameters:

descriptionKey - the key for the localized description of the configuration paramter

addOptionValue

public IGPConfigAttributeValue addOptionValue(String value,
                                              String key)

Adds a new value option for this configuration attribute. The value has localizable display text

Parameters:

value - the value option for this configuration attribute

key - the for the localizable display text

Returns:

the configuration attribute value

getConfigAttributeValues

public Collection getConfigAttributeValues()

Returns the configuration attribute values

Returns:

a collection of IGPConfigAttributeValue