com.webmethods.rtl.util.obj

Interface IPropertyBag

All Known Subinterfaces:

ICommandBean, ICommandBeanEx, IHandlerBean, IPortletBean, IPortletController, IPortletControllerBean

public interface IPropertyBag

Properties interface. This iterface is used to load, access, modify and persist properties.

Method Summary

Modifier and Type	Method and Description
void	assignProperties(Object bean) Assigns properties of the widget using properties values in this property bag.
IPropertyBag	createCopy() Creates copy (clone) for this property bag.
Map<String,Object>	getProperties() Returns map of portlet properties
Object	getProperty(String name) Gets the property of the portlet
void	load(Element storage) Loads property bag from a DOM element.
void	load(Reader storage) Loads property bag from a Reader that contains properties data.
void	load(String storage) Loads property bag from a string that contains properties data.
String	save() Saves property bag to string representation.
void	save(Writer storage) Saves property bag to a writer.
DifferenceMap	setProperties(Map<String,? extends Object> propMap) Sets all properties in the batch from Map This allows to speed up properties set process
void	setProperty(String name, Object value) Sets the property of the portlet

Method Detail

setProperty

void setProperty(String name,
                 Object value)
          throws PortalException

Sets the property of the portlet

Parameters:

name - of the property to be set

value - of the property

Throws:

PortalException

See Also:

getProperty(java.lang.String)

setProperties

DifferenceMap setProperties(Map<String,? extends Object> propMap)
                     throws PortalException

Sets all properties in the batch from Map This allows to speed up properties set process

Parameters:

propMap - Map implementation containing all properties to be set

Returns:

difference map, may be null

Throws:

PortalException

getProperty

Object getProperty(String name)
            throws PortalException

Gets the property of the portlet

Parameters:

name - of the property to be set

Returns:

value of the property

Throws:

PortalException

getProperties

Map<String,Object> getProperties()
                          throws PortalException

Returns map of portlet properties

Returns:

Map with name/value pairs

Throws:

PortalException

load

void load(String storage)
   throws IOException

Loads property bag from a string that contains properties data.

Parameters:

storage - string with all data for the property bag

Throws:

IOException

load

void load(Reader storage)
   throws IOException

Loads property bag from a Reader that contains properties data.

Parameters:

storage - reader with all data for the property bag

Throws:

IOException

See Also:

Reader

load

void load(Element storage)
   throws IOException

Loads property bag from a DOM element. interface.

Parameters:

storage - DOM element that contains property bag data

Throws:

IOException

save

String save()
     throws IOException

Saves property bag to string representation.

Returns:

string that contains property bag data

Throws:

IOException

save

void save(Writer storage)
   throws IOException

Saves property bag to a writer.

Parameters:

storage - writer to save the property bag data

Throws:

IOException

See Also:

Writer

assignProperties

void assignProperties(Object bean)
               throws PortalException

Assigns properties of the widget using properties values in this property bag.

Parameters:

bean - widget bean to assign properties

Throws:

PortalException

See Also:

IPortletBean

createCopy

IPropertyBag createCopy()

Creates copy (clone) for this property bag.

Returns:

the copy of itself