com.centrasite.jaxr.infomodel
Interface InternationalRichText


public interface InternationalRichText


Method Summary
 void addLocalizedRichText(LocalizedRichText localizedRichText)
          Adds a LocalizedRichText to this object.
 void addLocalizedRichTexts(java.util.Collection localizedRichTexts)
          Add a collection of LocalizedRichTexts.
 java.util.Collection getLocalizedRichTexts()
          Returns the LocalizedRichTexts associated with this object.
 RichText getValue()
          Get the RichText value for the Locale returned by Locale.getDefault().
 RichText getValue(java.util.Locale locale)
          Get the RichText value for the specified Locale.
 void removeLocalizedRichText(LocalizedRichText localizedRichText)
          Removes a LocalizedRichText from this object.
 void removeLocalizedRichTexts(java.util.Collection localizedRichTexts)
          Removes specified LocalizedRichTexts from this object.
 void setValue(java.util.Locale locale, RichText value)
          Set the RichText value for the specified Locale.
 void setValue(RichText value)
          Set the RichText value for the Locale returned by Locale.getDefault().
 

Method Detail

getValue

RichText getValue()
                  throws javax.xml.registry.JAXRException
Get the RichText value for the Locale returned by Locale.getDefault().

Returns:
the RichText value for the Locale returned by Locale.getDefault()
Throws:
javax.xml.registry.JAXRException

getValue

RichText getValue(java.util.Locale locale)
                  throws javax.xml.registry.JAXRException
Get the RichText value for the specified Locale. Return null if no locale specific value is found for the specified locale.

Parameters:
locale - The Locale for the desired value
Returns:
the RichText value for the specified Locale
Throws:
javax.xml.registry.JAXRException

setValue

void setValue(RichText value)
              throws javax.xml.registry.JAXRException
Set the RichText value for the Locale returned by Locale.getDefault().

Parameters:
value - the RichText value for the Locale returned by Locale.getDefault()
Throws:
javax.xml.registry.JAXRException

setValue

void setValue(java.util.Locale locale,
              RichText value)
              throws javax.xml.registry.JAXRException
Set the RichText value for the specified Locale.

Parameters:
locale - The locale for this value being set
value - The value being set
Throws:
javax.xml.registry.JAXRException

addLocalizedRichText

void addLocalizedRichText(LocalizedRichText localizedRichText)
                          throws javax.xml.registry.JAXRException
Adds a LocalizedRichText to this object.

Parameters:
localizedRichText - the LocalizedRichText to be added
Throws:
javax.xml.registry.JAXRException

addLocalizedRichTexts

void addLocalizedRichTexts(java.util.Collection localizedRichTexts)
                           throws javax.xml.registry.JAXRException
Add a collection of LocalizedRichTexts.

Parameters:
localizedRichTexts - the Collection of LocalizedRichTexts to be added
Throws:
javax.xml.registry.JAXRException

removeLocalizedRichText

void removeLocalizedRichText(LocalizedRichText localizedRichText)
                             throws javax.xml.registry.JAXRException
Removes a LocalizedRichText from this object.

Parameters:
localizedRichText - the LocalizedRichText to be removed
Throws:
javax.xml.registry.JAXRException

removeLocalizedRichTexts

void removeLocalizedRichTexts(java.util.Collection localizedRichTexts)
                              throws javax.xml.registry.JAXRException
Removes specified LocalizedRichTexts from this object.

Parameters:
localizedRichTexts - the Collection of LocalizedRichTexts to be removed
Throws:
javax.xml.registry.JAXRException

getLocalizedRichTexts

java.util.Collection getLocalizedRichTexts()
                                           throws javax.xml.registry.JAXRException
Returns the LocalizedRichTexts associated with this object.

Returns:
Collection of LocalizedRichText instances. May be empty but not null.
Throws:
javax.xml.registry.JAXRException