*** This interface is subject to change. ***

com.sas.iquery.metadata
Interface LocalizableNamedObjectInterface

All Superinterfaces:

com.sas.util.LocalizableToStringInterface, NamedObjectInterface

All Known Subinterfaces:

BusinessGroup, BusinessItem, CompoundFilter, DataItem, DataItemReference, FilterItem, LocalizableModelObject, MapFolder, Prompt

All Known Implementing Classes:

Category, Function, Operator, SASFormatCategory

public interface LocalizableNamedObjectInterface
extends NamedObjectInterface, com.sas.util.LocalizableToStringInterface

Specifies basic getter methods for objects that have labels and descriptions that can be configured based on Locale.

Method Summary

java.lang.String	getDescription(java.util.Locale locale) Returns a description for this object for a specific locale, typically for display purposes.
com.sas.util.LocalizableString	getDescriptions() Returns the entire set of descriptions for this object for all locales, typically for display purposes.
java.lang.String	getLabel(java.util.Locale locale) Returns a label for this object for a specific locale, typically for display purposes.
com.sas.util.LocalizableString	getLabels() Returns the entire set of labels for this object for all locales, typically for display purposes.

Methods inherited from interface com.sas.iquery.metadata.NamedObjectInterface

getDescription, getLabel

Method Detail

getLabel

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

Returns a label for this object for a specific locale, typically for display purposes.

Parameters:

locale - the Locale of the label, null will use Locale.getDefault()

Returns:

String the label for the given locale or the same as getLabel() if no label set for the locale

getDescription

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

Returns a description for this object for a specific locale, typically for display purposes. A description is intended to provide a longer worded phrase than the label itself.

Parameters:

locale - the Locale of the description, null will use Locale.getDefault()

Returns:

String the description for the given locale or the same as getDescription() if no description set for the locale

getLabels

com.sas.util.LocalizableString getLabels()

Returns the entire set of labels for this object for all locales, typically for display purposes.

Returns:

a copy of the LocalizableString containing the labels

getDescriptions

com.sas.util.LocalizableString getDescriptions()

Returns the entire set of descriptions for this object for all locales, typically for display purposes. A description is intended to provide a longer worded phrase than the label itself.

Returns:

a copy of the LocalizableString containing the descriptions

*** This interface is subject to change. ***