com.softwareag.centrasite.api.csom
Interface CentraSiteInternationalString


public interface CentraSiteInternationalString

CentraSiteInternationalString which the holds the information of available indifferent locale's.
User can use this object to get the CentraSiteLocalizedString based on the required locale's, if the values exists for that specified locale then return the corresponding locale's CentraSiteLocalizedString other wise null.


Method Summary
 void addLocalizedString(CentraSiteLocalizedString localizedString)
          Adds a CentraSiteLocalizedString to this object.
 void addLocalizedStrings(java.util.Collection<CentraSiteLocalizedString> localizedStrings)
          Adds many CSOLocalizedStrings to this object.
 boolean containsValue(java.lang.String value)
          Check whether one of the localized strings is equal to the given value.
 CentraSiteLocalizedString getLocalizedString(java.util.Locale locale, java.lang.String charsetName)
          Gets the CentraSiteLocalizedString for the specified Locale and charsetName.
 java.util.Collection<CentraSiteLocalizedString> getLocalizedStrings()
          Returns the CSOLocalizedStrings associated with this object.
 java.lang.String getLocalStringValue(java.util.Locale locale)
          Gets the String value for the specified Locale.
 java.lang.String getValue()
          Gets the String value for the user locale.
 java.lang.String getValue(java.util.Locale locale)
          Gets the String value for the specified Locale.
 void removeLocalizedString(CentraSiteLocalizedString localizedString)
          Removes a LocalizedString from this object.
 void removeLocalizedStrings(java.util.Collection<CentraSiteLocalizedString> localizedStrings)
          Removes specified LocalizedStrings to this object.
 void setValue(java.util.Locale locale, java.lang.String value)
          Sets the String value for the specified Locale.
 void setValue(java.lang.String value)
          Sets the String value for the user locale.
 

Method Detail

addLocalizedString

void addLocalizedString(CentraSiteLocalizedString localizedString)
Adds a CentraSiteLocalizedString to this object.

Parameters:
localizedString -

addLocalizedStrings

void addLocalizedStrings(java.util.Collection<CentraSiteLocalizedString> localizedStrings)
Adds many CSOLocalizedStrings to this object.

Parameters:
localizedStrings -

getLocalizedString

CentraSiteLocalizedString getLocalizedString(java.util.Locale locale,
                                             java.lang.String charsetName)
Gets the CentraSiteLocalizedString for the specified Locale and charsetName.

Parameters:
locale - The Locale for the desired value. If null the default locale is used.
charsetName -
Returns:
CentraSiteLocalizedString for the specified Locale and charsetName

getLocalizedStrings

java.util.Collection<CentraSiteLocalizedString> getLocalizedStrings()
Returns the CSOLocalizedStrings associated with this object.

Returns:
Collection of CentraSiteLocalizedString for this object

getValue

java.lang.String getValue()
Gets the String value for the user locale.

Returns:
String value for the user locale

getValue

java.lang.String getValue(java.util.Locale locale)
Gets the String value for the specified Locale.

Parameters:
locale - The Locale for the desired value. If null the default locale is used.
Returns:
the String value for the specified Locale

removeLocalizedString

void removeLocalizedString(CentraSiteLocalizedString localizedString)
Removes a LocalizedString from this object.

Parameters:
localizedString -

removeLocalizedStrings

void removeLocalizedStrings(java.util.Collection<CentraSiteLocalizedString> localizedStrings)
Removes specified LocalizedStrings to this object.

Parameters:
localizedStrings -

setValue

void setValue(java.util.Locale locale,
              java.lang.String value)
Sets the String value for the specified Locale.

Parameters:
locale - The Locale for the desired value. If null the default locale is used.
value -

setValue

void setValue(java.lang.String value)
Sets the String value for the user locale.

Parameters:
value -

containsValue

boolean containsValue(java.lang.String value)
Check whether one of the localized strings is equal to the given value.

Parameters:
value -
Returns:
true if the value is equal. false otherwise

getLocalStringValue

java.lang.String getLocalStringValue(java.util.Locale locale)
Gets the String value for the specified Locale.

Parameters:
locale - The Locale for the desired value. If null the default locale is used.
Returns:
String value for the specified Locale