lumis.portal.propertybag
Interface IPropertyBagManager

All Known Implementing Classes:

PropertyBagManager

@StableMinor(version="5.5",
             sinceVersion="5.0")
public interface IPropertyBagManager

Manages property bag instances. All methods require a transactional context.

Since:

5.0.0

Method Summary

void	add(PropertyBag bag) Persists a property bag.
void	delete(PropertyBag bag) Deletes the given property bag.
PropertyBag	get(String propertyBagId) Returns the property bag with the given identifier.

Method Detail

add

void add(PropertyBag bag)
         throws PortalException

Persists a property bag.

Parameters:

bag - the property bag to persist.

Throws:

PortalException

Since:

5.0.0

get

PropertyBag get(String propertyBagId)
                throws PortalException

Returns the property bag with the given identifier.

Parameters:

propertyBagId - identifier of the property bag.

Returns:

the property bag.

Throws:

PortalException

Since:

5.0.0

delete

void delete(PropertyBag bag)
            throws PortalException

Deletes the given property bag.

Delete is not done recursively. There must not be any child property bags that have the given property bag as its parent.

Parameters:

bag - the property bag to be deleted.

Throws:

PortalException

Since:

5.0.0