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

All Known Subinterfaces:

IMetricDescriptions

public interface IMetricDescriptionsBase

This interface provides an interface the Server Intelligence resources for multilingual descriptions and display templates.

Field Summary

static java.lang.String	KIND
static java.lang.String	PROGID

Method Summary

IMLDescriptions	getMetricDescriptions(java.lang.String serviceInterfaceName) Returns an interface to the collection of property render templates for the specified service interface.
java.lang.String	getMLDescription(java.lang.String name, java.lang.String value, java.util.Locale locale) Returns a localized string for the specified name, value and locale.
IPropertyBagRenderTemplate	getPropertyBagRenderTemplate(java.lang.String name) Returns an interface to the display information for the specified template
java.util.Set	getPropertyBagRenderTemplateNames() Returns a Set containing the names of the templates for which display information is available.
java.lang.String	getServerKindDescription(java.lang.String serverKind, java.util.Locale locale) Returns the localized description for the specified server kind and locale.
java.util.Set	getServerKinds() Returns the server kinds for which there are multilingual descriptions available.
java.lang.String	getServiceFriendlyName(java.lang.String serviceInterfaceName, java.util.Locale loc) Returns a user friendly string of the specified service interface name
java.util.Set	getServiceInterfaceNames() Returns a set of service interface names for which there are multilingual descriptions.

Field Detail

KIND

static final java.lang.String KIND

See Also:

Constant Field Values

PROGID

static final java.lang.String PROGID

See Also:

Constant Field Values

Method Detail

getServiceInterfaceNames

java.util.Set getServiceInterfaceNames()
                                       throws SDKException

Returns a set of service interface names for which there are multilingual descriptions.

Returns:

A set of service interface names.

Throws:

SDKException

InfoObject properties to query for:

SI_METRIC_DESCRIPTIONS

getServiceFriendlyName

java.lang.String getServiceFriendlyName(java.lang.String serviceInterfaceName,
                                        java.util.Locale loc)
                                        throws SDKException

Returns a user friendly string of the specified service interface name

Parameters:

serviceInterfaceName - The service interface name for a set of metrics

loc - The type of locale you want the friendly name to be returned in.

Returns:

The localized friendly service name

Throws:

SDKException

InfoObject properties to query for:

SI_METRIC_DESCRIPTIONS

getMetricDescriptions

IMLDescriptions getMetricDescriptions(java.lang.String serviceInterfaceName)
                                      throws SDKException

Returns an interface to the collection of property render templates for the specified service interface.

Parameters:

serviceInterfaceName - A service interface name.

Returns:

A collection of property render templates.

Throws:

SDKException

InfoObject properties to query for:

SI_METRIC_DESCRIPTIONS

getServerKinds

java.util.Set getServerKinds()
                             throws SDKException

Returns the server kinds for which there are multilingual descriptions available.

Returns:

A set of server kinds.

Throws:

SDKException

InfoObject properties to query for:

SI_SERVER_KIND_DESCRIPTIONS

getServerKindDescription

java.lang.String getServerKindDescription(java.lang.String serverKind,
                                          java.util.Locale locale)
                                          throws SDKException

Returns the localized description for the specified server kind and locale.

Parameters:

serverKind - The server kind.

locale - The locale for the requested description.

Returns:

The localized server kind description

Throws:

SDKException

InfoObject properties to query for:

SI_SERVER_KIND_DESCRIPTIONS

getMLDescription

java.lang.String getMLDescription(java.lang.String name,
                                  java.lang.String value,
                                  java.util.Locale locale)

Returns a localized string for the specified name, value and locale.

Parameters:

name - The name of a service interface.

value - The name of a propety or metric.

locale - The locale for the requested description.

Returns:

The localized descriptive string.

InfoObject properties to query for:

SI_STRING_MAPS

getPropertyBagRenderTemplateNames

java.util.Set getPropertyBagRenderTemplateNames()

Returns a Set containing the names of the templates for which display information is available.

Returns:

A set of names.

InfoObject properties to query for:

SI_PROPBAG_TEMPLATES

getPropertyBagRenderTemplate

IPropertyBagRenderTemplate getPropertyBagRenderTemplate(java.lang.String name)

Returns an interface to the display information for the specified template

Parameters:

name - Name of the template.

Returns:

Display information for a property bag template.

InfoObject properties to query for:

SI_PROPBAG_TEMPLATES