com.plumtree.server
Interface IPTLocalizable

All Superinterfaces:

IPTUnknown

All Known Subinterfaces:

IPTAdminFolder, IPTAuthSource, IPTCard, IPTCommunity, IPTCommunityTemplate, IPTCrawler, IPTDataSource, IPTDocumentType, IPTExpression, IPTExternalOperation, IPTFederatedPortal, IPTFilter, IPTFolder, IPTGadget, IPTGadgetBundle, IPTGadgetContentServer, IPTGadgetTemplate, IPTGuestLogin, IPTInvitation, IPTJob, IPTMyPages, IPTObject, IPTPage, IPTPageContainer, IPTPageTemplate, IPTPreferencesContext, IPTProfilePage, IPTProfileSection, IPTProfileSource, IPTProperty, IPTSavedSearch, IPTSiteMapFolder, IPTSubPortal, IPTTaxonomist, IPTUser, IPTUserGroup, IPTUserInterface, IPTWebService

public interface IPTLocalizable
extends IPTUnknown

This interface is supported by objects that support localization of their names and descriptions. Localization allows a single object to have different strings for different languages- the name or description can be different for English and French speakers, for example.

Author:

michaels

See Also:

IPTStringLocalizationManager

Method Summary

java.lang.String	GetDescription() Returns the primary description of the object.
boolean	GetIsLocalized() Does this object support localization? Note that an object may support localization, but nonetheless have no actual localizations.
java.lang.String	GetLocalizedDescription() Return the description of this object localized to the language of the current user
java.lang.Object[][]	GetLocalizedDescriptions() Returns the localized descriptions for this object as a 2D array.
java.lang.String	GetLocalizedName() Return the name of this object localized to the language of the current user
java.lang.Object[][]	GetLocalizedNames() Returns the localized names for this object as a 2D array.
java.lang.String	GetName() Returns the primary name of the object.
java.lang.String	GetPrimaryLang() The primary language of the object is the language that the primary name and primary description are in.
boolean	GetSupportsLocalization() Does this type of object support localization? Some object types (IPTCard, for example) do not support localization.
void	SetDescription(java.lang.String Value) Sets the primary description of the object.
void	SetIsLocalized(boolean Value) Does this object support localization? Note that an object may support localization, but nonetheless have no actual localizations.
void	SetLocalizedDescriptions(java.lang.Object[][] Value) Sets the localized descriptions for this object.
void	SetLocalizedNames(java.lang.Object[][] Value) Sets the localized names for this object.
void	SetName(java.lang.String Value) Sets the primary name of the object.
void	SetPrimaryLang(java.lang.String Value) The primary language of the object is the language that the primary name and primary description are in.

Methods inherited from interface com.plumtree.server.IPTUnknown

GetInterfaces

Method Detail

GetName

java.lang.String GetName()

Returns the primary name of the object. This name will be used when the language of the user isn't known or isn't supported.

Returns:

the name

SetName

void SetName(java.lang.String Value)

Sets the primary name of the object. This name will be used when the language of the user isn't known or isn't supported.

Parameters:

Value - the name

GetDescription

java.lang.String GetDescription()

Returns the primary description of the object. This description will be used when the language of the user isn't known or isn't supported.

Returns:

the description

SetDescription

void SetDescription(java.lang.String Value)

Sets the primary description of the object. This description will be used when the language of the user isn't known or isn't supported.

Parameters:

Value - the description

GetLocalizedNames

java.lang.Object[][] GetLocalizedNames()

Returns the localized names for this object as a 2D array. The purpose of each column is identified by the constants in PT_LOCALIZED_STRINGS_INDICES.

Returns:

the localized names

See Also:

PT_LOCALIZED_STRINGS_INDICES

SetLocalizedNames

void SetLocalizedNames(java.lang.Object[][] Value)

Sets the localized names for this object.

Parameters:

Value - an array containing the data about localized names. The columns in the 2D array are identified by the constants in PT_LOCALIZED_STRINGS_INDICES.

See Also:

PT_LOCALIZED_STRINGS_INDICES

GetLocalizedName

java.lang.String GetLocalizedName()

Return the name of this object localized to the language of the current user

Returns:

the localized name

GetLocalizedDescriptions

java.lang.Object[][] GetLocalizedDescriptions()

Returns the localized descriptions for this object as a 2D array. The purpose of each column is identified by the constants in PT_LOCALIZED_STRINGS_INDICES.

Returns:

the localized descriptions

See Also:

PT_LOCALIZED_STRINGS_INDICES

SetLocalizedDescriptions

void SetLocalizedDescriptions(java.lang.Object[][] Value)

Sets the localized descriptions for this object.

Parameters:

Value - an array containing the data about localized descriptions. The columns in the 2D array are identified by the constants in PT_LOCALIZED_STRINGS_INDICES.

See Also:

PT_LOCALIZED_STRINGS_INDICES

GetLocalizedDescription

java.lang.String GetLocalizedDescription()

Return the description of this object localized to the language of the current user

Returns:

the localized description

GetIsLocalized

boolean GetIsLocalized()

Does this object support localization? Note that an object may support localization, but nonetheless have no actual localizations. That is, the object is marked to be localized, but localization hasn't been done yet.

Returns:

does the object support localization?

SetIsLocalized

void SetIsLocalized(boolean Value)

Does this object support localization? Note that an object may support localization, but nonetheless have no actual localizations. That is, the object is marked to be localized, but localization hasn't been done yet. Note that if an object supports localization, and SetIsLocalized(false) is called, all localized strings will be removed from the object.

Parameters:

Value - boolean indicating whether this object should support localization.

GetPrimaryLang

java.lang.String GetPrimaryLang()

The primary language of the object is the language that the primary name and primary description are in. Other metadata about the object (which cannot be localized) is also expected to be in this language.

Returns:

the primary language

SetPrimaryLang

void SetPrimaryLang(java.lang.String Value)

The primary language of the object is the language that the primary name and primary description are in. Other metadata about the object (which cannot be localized) is also expected to be in this language.

Parameters:

Value - the primary language

GetSupportsLocalization

boolean GetSupportsLocalization()

Does this type of object support localization? Some object types (IPTCard, for example) do not support localization. Calling functions like SetLocalizedNames on an object that does not support localization will result in an error.

Returns:

Does this type of object support localization?