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

com.sas.iquery.metadata.business
Interface LocalizableModelObject

All Superinterfaces:

LocalizableNamedObjectInterface, com.sas.util.LocalizableToStringInterface, NamedObjectInterface

All Known Subinterfaces:

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

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

Implemented by a model object that has localized labels and descriptions and provides methods to modify them.

Field Summary

static java.lang.String	EVENT_LOCALIZABLE_DESCRIPTIONS_CHANGED Description associated with the object has changed.
static java.lang.String	EVENT_LOCALIZABLE_LABELS_CHANGED Label associated with the object has changed.

Method Summary

com.sas.storage.editableproperties.PropertyList	getLocalizableProperties(java.util.Locale locale) Returns the localizable properties for a business model in the form of PropertyList.
java.lang.String	getLocalizationPrependKey()
void	setDescription(java.lang.String description, java.util.Locale locale) Sets the description for this object.
void	setDescriptions(com.sas.util.LocalizableString descriptions) Sets the description for this object.
void	setLabel(java.lang.String label, java.util.Locale locale) Sets the label for this object.
void	setLabels(com.sas.util.LocalizableString labels) Sets the label for this object.
void	setLocalizableProperties(java.util.Locale locale, com.sas.storage.editableproperties.PropertyMap map) Sets the localizable properties for the business model.

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

getDescription, getDescriptions, getLabel, getLabels

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

getDescription, getLabel

Field Detail

*** This field is subject to change. ***

EVENT_LOCALIZABLE_DESCRIPTIONS_CHANGED

static final java.lang.String EVENT_LOCALIZABLE_DESCRIPTIONS_CHANGED

Description associated with the object has changed.

See Also:

Constant Field Values

*** This field is subject to change. ***

EVENT_LOCALIZABLE_LABELS_CHANGED

static final java.lang.String EVENT_LOCALIZABLE_LABELS_CHANGED

Label associated with the object has changed.

See Also:

Constant Field Values

Method Detail

*** This method is subject to change. ***

setDescription

void setDescription(java.lang.String description,
                    java.util.Locale locale)
                    throws MetadataException

Sets the description for this object. A description is intended to provide a longer worded phrase than the label itself.

Property change events signalled:

• EVENT_LOCALIZABLE_DESCRIPTIONS_CHANGED

Parameters:

locale - The Locale this description is specific to. Specifying null is allowed and it will set the current value of Locale.getDefault()

description - The string to use as the description. Specifying null is allowed and if a value is assigned for the locale it will be cleared.

Throws:

MetadataNotChangeableException - if this BusinessModelObject is read-only

MetadataException

*** This method is subject to change. ***

setDescriptions

void setDescriptions(com.sas.util.LocalizableString descriptions)
                     throws MetadataException

Sets the description for this object. A description is intended to provide a longer worded phrase than the label itself.

Property change events signalled:

• EVENT_LOCALIZABLE_DESCRIPTIONS_CHANGED

Parameters:

descriptions - The IqLocalizableString to use as the descriptions. Specifying null is allowed.

Throws:

MetadataNotChangeableException - if this BusinessModelObject is read-only

MetadataException

*** This method is subject to change. ***

setLabel

void setLabel(java.lang.String label,
              java.util.Locale locale)
              throws MetadataException

Sets the label for this object.

Property change events signalled:

• EVENT_LOCALIZABLE_LABELS_CHANGED

Parameters:

locale - The Locale this label is specific to. Specifying null is allowed and it will set the current value of Locale.getDefault()

label - The string to use as the label. Specifying null is allowed and if a value is assigned for the locale it will be cleared.

Throws:

MetadataNotChangeableException - if this BusinessModelObject is read-only

MetadataException

*** This method is subject to change. ***

setLabels

void setLabels(com.sas.util.LocalizableString labels)
               throws MetadataException

Sets the label for this object.

Property change events signalled:

• EVENT_LOCALIZABLE_LABELS_CHANGED

Parameters:

labels - The IqLocalizableString to use as the labels. Specifying null is allowed.

Throws:

MetadataNotChangeableException - if this BusinessModelObject is read-only

MetadataException

getLocalizationPrependKey

java.lang.String getLocalizationPrependKey()

*** This method is subject to change. ***

getLocalizableProperties

com.sas.storage.editableproperties.PropertyList getLocalizableProperties(java.util.Locale locale)
                                                                         throws MetadataException

Returns the localizable properties for a business model in the form of PropertyList. The localizable properties for a business model are the labels and descriptions of datasources, data items and filter items and prompts.

Parameters:

locale - Locale for the specified map.

Throws:

MetadataException

See Also:

MultiLocaleProperties.getLocalizableProperties(Locale)

*** This method is subject to change. ***

setLocalizableProperties

void setLocalizableProperties(java.util.Locale locale,
                              com.sas.storage.editableproperties.PropertyMap map)
                              throws MetadataException

Sets the localizable properties for the business model. The localizable properties for a business model are the labels and descriptions of datasources, data items and filter items and prompts.

Parameters:

locale - Locale for the specified map.

map - PropertyMap containing the localized version of the business model properties.

Throws:

MetadataException

See Also:

MultiLocaleProperties.setLocalizableProperties(Locale, com.sas.storage.editableproperties.PropertyMap)

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