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

public interface IPropertyBagRenderTemplate

This interface provides access to property bag display information.

Method Summary

java.lang.String	getLabel(java.lang.String name, java.util.Locale locale) Returns the localized string for a label.
java.util.Set	getLabelNames() Returns the label names.
java.lang.String	getName() Returns the name of the property bag this display information describes.
IPropertyRenderTemplates	getPropertyRenderTemplates() Returns an interface to a collection of property render templates.
java.lang.String	getPropNamePrefix() Returns the prefix used for the property names in the property bag.
java.lang.String	getSubRenderTemplateName() Returns the name of the nested template.
java.lang.String	getTotalID() Returns the name of the property that is used to identify the total number of properties in a collection.
ValueFormat	getValueFormat() Returns the value type that is to be displayed.

Method Detail

getName

java.lang.String getName()

Returns the name of the property bag this display information describes.

Returns:

A property bag name.

getPropNamePrefix

java.lang.String getPropNamePrefix()

Returns the prefix used for the property names in the property bag. Returns an empty string if there is no prefix defined.

Returns:

A prefix string.

getTotalID

java.lang.String getTotalID()

Returns the name of the property that is used to identify the total number of properties in a collection. e.g. SI_TOTAL

Returns:

A property name.

getPropertyRenderTemplates

IPropertyRenderTemplates getPropertyRenderTemplates()

Returns an interface to a collection of property render templates.

Returns:

An interface to the display information for related properties.

getLabelNames

java.util.Set getLabelNames()

Returns the label names.

Returns:

A set of label names.

getLabel

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

Returns the localized string for a label.

Parameters:

name - The label name.

locale - The locale of the requested label.

Returns:

The localized label name.

getSubRenderTemplateName

java.lang.String getSubRenderTemplateName()

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

Returns:

Name of the nested template.

getValueFormat

ValueFormat getValueFormat()

Returns the value type that is to be displayed.

Returns:

The value type to be displayed.