com.ibm.mashups.iwidget.widget
Interface ModifiableProperties

All Superinterfaces:

Properties

public ModifiableProperties
extends Properties

Modifiable interface defines functions to iterates , updates and persist Properties.

Method Summary

Properties	setItemValue(String itemName, String itemValue, Boolean readOnly, String locale) This method creates or overwrites the value of the required item
Properties	removeItem(String itemName) Removes the named item from the set.
void	removeItemValue(String itemName, String locale) Removes the specified item value with the given locale.

Methods inherited from interface com.ibm.mashups.iwidget.widget.Properties

getItemValue, getAllNames, getItemLocales, isReadOnly

Method Detail

setItemValue

Properties setItemValue(String itemName,
                        String itemValue,
                        Boolean readOnly,
                        String locale)

This method creates or overwrites the value of the required item

Parameters:

itemName - name of the item. Must never be NULL.

itemValue - value of the item. Must never be NULL.

readOnly - whether the item value is read only (on this level).

locale - the locale in which the item value is

Returns:

return an handle of InstanceProperties upon successful, NULL upon failure.

removeItem

Properties removeItem(String itemName)

Removes the named item from the set.

Parameters:

itemName - name of the item that should be removed.Must never be NULL.

Returns:

return an handle of InstanceProperties upon successful, NULL upon failure..

removeItemValue

void removeItemValue(String itemName,
                     String locale)

Removes the specified item value with the given locale.

Parameters:

itemName - the name of the item for which to remove the value.

locale - the locale of the value to remove. Must never be NULL