lumis.portal.propertybag

Class PropertyBagManager

java.lang.Object

lumis.portal.propertybag.PropertyBagManager

All Implemented Interfaces:

IPropertyBagManager, IPropertyBagManagerSPI

public class PropertyBagManager
extends Object
implements IPropertyBagManagerSPI

Property bag manager implementation.

Since:

5.0.0

Version:

$Revision: 23034 $ $Date: 2019-08-05 19:52:47 +0000 (Mon, 05 Aug 2019) $

Constructor Summary

Constructors

Constructor and Description
PropertyBagManager()

Method Summary

Modifier and Type	Method and Description
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.
String	getValue(String propertyBagId, String propertyName, String defaultValue) Returns the value of the property with the given name for the property bag with the given identifier and, if no value was found, return the given default value. The calculated value will be calculated considering the inherited values. When changing some property bag values, the new values will only be available in this method after the transaction that changed the property bag values is commited. This method is preferable to PropertyBag.getValue(String, String).
Map<String,List<String>>	getValueMap(String propertyBagId) Returns the value map for the property bag with the given identifier. The resulting map will be calculated considering the inherited values and will be an unmodifiable map. When changing some property bag values, the new values will only be available in this method after the transaction that changed the property bag values is commited. This method is preferable to PropertyBag.getValueMap().
Tuple2<Map<String,List<String>>,Map<String,List<String>>>	getValues(String propertyBagId) Returns the property bag values. The local values will be in a slot and the complete values (with the inherited values) will be in b slot.
List<String>	getValues(String propertyBagId, String propertyName, List<String> defaultValues) Returns the values of the property with the given name for the property bag with the given identifier and, if no value was found, return the given default values. The calculated value will be calculated considering the inherited values. When changing some property bag values, the new values will only be available in this method after the transaction that changed the property bag values is commited. If the values could be calculated (and, thus, the default values are not used), the returned list will be immutable. If the values couldn't be found, the default values will be returned and, whether it is an immutable list is not defined. This method is preferable to PropertyBag.getValues(String, List).
static void	scheduleClearCache(String propertyBagId) Schedules a cache clear if needed.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PropertyBagManager

public PropertyBagManager()

Method Detail

add

public void add(PropertyBag bag)
         throws PortalException

Description copied from interface: IPropertyBagManager

Persists a property bag.

Specified by:

add in interface IPropertyBagManager

Parameters:

bag - the property bag to persist.

Throws:

PortalException

get

public PropertyBag get(String propertyBagId)
                throws PortalException

Description copied from interface: IPropertyBagManager

Returns the property bag with the given identifier.

Specified by:

get in interface IPropertyBagManager

Parameters:

propertyBagId - identifier of the property bag.

Returns:

the property bag.

Throws:

PortalException

delete

public void delete(PropertyBag bag)
            throws PortalException

Description copied from interface: IPropertyBagManager

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.

Specified by:

delete in interface IPropertyBagManager

Parameters:

bag - the property bag to be deleted.

Throws:

PortalException

getValue

public String getValue(String propertyBagId,
                       String propertyName,
                       String defaultValue)
                throws PortalException

Description copied from interface: IPropertyBagManager

Returns the value of the property with the given name for the property bag with the given identifier and, if no value was found, return the given default value.
The calculated value will be calculated considering the inherited values.
When changing some property bag values, the new values will only be available in this method after the transaction that changed the property bag values is commited.
This method is preferable to PropertyBag.getValue(String, String).

Specified by:

getValue in interface IPropertyBagManager

Parameters:

propertyBagId - the property bag identifier.

propertyName - the property name.

defaultValue - the default value.

Returns:

the calculated value or the default value if no value was found.

Throws:

PortalObjectNotFoundException - if no property bag with the given identifier was found.

PortalException

getValues

public Tuple2<Map<String,List<String>>,Map<String,List<String>>> getValues(String propertyBagId)
                                                                    throws PortalException

Description copied from interface: IPropertyBagManagerSPI

Returns the property bag values.
The local values will be in a slot and the complete values (with the inherited values) will be in b slot.

Specified by:

getValues in interface IPropertyBagManagerSPI

Parameters:

propertyBagId - the property bag identifier.

Returns:

the property bag values

Throws:

PortalObjectNotFoundException - if no property with the given identifier was found.

PortalException

getValues

public List<String> getValues(String propertyBagId,
                              String propertyName,
                              List<String> defaultValues)
                       throws PortalException

Description copied from interface: IPropertyBagManager

Returns the values of the property with the given name for the property bag with the given identifier and, if no value was found, return the given default values.
The calculated value will be calculated considering the inherited values.
When changing some property bag values, the new values will only be available in this method after the transaction that changed the property bag values is commited.
If the values could be calculated (and, thus, the default values are not used), the returned list will be immutable.
If the values couldn't be found, the default values will be returned and, whether it is an immutable list is not defined.

This method is preferable to PropertyBag.getValues(String, List).

Specified by:

getValues in interface IPropertyBagManager

Parameters:

propertyBagId - the property bag identifier.

propertyName - the property name.

Returns:

the calculated values or the default values if no value was found.

Throws:

PortalObjectNotFoundException - if no property bag with the given identifier was found.

PortalException

getValueMap

public Map<String,List<String>> getValueMap(String propertyBagId)
                                     throws PortalException

Description copied from interface: IPropertyBagManager

Returns the value map for the property bag with the given identifier.
The resulting map will be calculated considering the inherited values and will be an unmodifiable map.
When changing some property bag values, the new values will only be available in this method after the transaction that changed the property bag values is commited.
This method is preferable to PropertyBag.getValueMap().

Specified by:

getValueMap in interface IPropertyBagManager

Parameters:

propertyBagId - the property bag identifier.

Returns:

the value map for the property bag with the given identifier.

Throws:

PortalObjectNotFoundException - if no property bag with the given identifier was found.

PortalException

scheduleClearCache

public static void scheduleClearCache(String propertyBagId)
                               throws PortalException

Schedules a cache clear if needed.

Parameters:

propertyBagId - the property bag identifier.

Throws:

PortalException

Since:

12.0.0