com.businessobjects.sdk.plugin.desktop.metricdescriptions
Interface IPropertyRenderTemplate


public interface IPropertyRenderTemplate

This interface provides access to property display information.


Method Summary
 java.lang.Object getID()
           Returns the property ID for which this display information applies.
 java.lang.String getLabel(java.util.Locale locale)
           Returns the localized label for this property.
 java.lang.String getRenderTemplateName()
           Returns the name of the nested template.
 java.lang.String getStringMapName()
           Returns the name of the map containing the strings that can be used for this property.
 ValueFormat getValueFormat()
           Returns the value type of the property to be displayed.
 boolean isConfigurable()
          Returns true if this metric can be configured
 

Method Detail

getID

java.lang.Object getID()

Returns the property ID for which this display information applies.

Returns:
A property ID.

getValueFormat

ValueFormat getValueFormat()

Returns the value type of the property to be displayed.

Returns:
A value type.

getLabel

java.lang.String getLabel(java.util.Locale locale)

Returns the localized label for this property.

Parameters:
locale - The desired locale for the label.
Returns:
The localized label.

getStringMapName

java.lang.String getStringMapName()

Returns the name of the map containing the strings that can be used for this property.

Returns:
The name of a map.

getRenderTemplateName

java.lang.String getRenderTemplateName()

Returns the name of the nested template. Returns null if there is none defined.

Returns:
Name of the nested template.

isConfigurable

boolean isConfigurable()
Returns true if this metric can be configured

Returns: