Package lumis.portal.structure.sync.model.propertybag

Class PropertyBag

java.lang.Object

lumis.portal.structure.sync.model.propertybag.PropertyBag

All Implemented Interfaces:

java.io.Serializable, ICustomEquivalence, IDefaultAware

public class PropertyBag
extends java.lang.Object
implements IDefaultAware, ICustomEquivalence, java.io.Serializable

Property bag model.

Documentation in this class focus synchronization behavior. About the use behind the fields in the portal, see PropertyBag.

Since:

6.2.0

Version:

$Revision$ $Date$

See Also:

PropertyBag, Serialized Form

Constructor Summary

Constructors

Constructor	Description
PropertyBag()

Method Summary

Modifier and Type	Method	Description
java.lang.String	getId()
java.lang.String	getParentPropertyBagId()
java.util.List<Property>	getProperties()
Property	getPropertyToSetValue(java.lang.String propertyName)	Returns the property to set value on.
java.lang.String	getValue(java.lang.String propertyName)	Returns the value of the given property.
boolean	isDefault()	Returns whether this object is equivalent to the default value.
boolean	isEquivalent(java.lang.Object obj)	Returns whether this object is equivalent to the given object.
java.util.List<java.lang.String>	removeProperties(java.lang.String propertyName)	Removes and returns the values of the given property.
java.lang.String	removeProperty(java.lang.String propertyName)
void	setDefaultValue(java.lang.String propertyName, java.lang.String value)
void	setDefaultValue(java.lang.String propertyName, java.lang.String value, Property.InheritMode inheritMode)	Sets the default value.
void	setDefaultValues(java.lang.String propertyName, java.util.List<java.lang.String> values)	Sets the property default values.
void	setDefaultValues(java.lang.String propertyName, java.util.List<java.lang.String> values, Property.InheritMode inheritMode)	Sets the property default values.
void	setId(java.lang.String id)
void	setParentPropertyBagId(java.lang.String parentPropertyBagId)

Methods inherited from class java.lang.Object

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

Constructor Detail

PropertyBag

public PropertyBag()

Method Detail

isDefault

public boolean isDefault()

Description copied from interface: IDefaultAware

Returns whether this object is equivalent to the default value.

Specified by:

isDefault in interface IDefaultAware

Returns:

true if this object is equivalent to the default value, false otherwise.

isEquivalent

public boolean isEquivalent(java.lang.Object obj)

Description copied from interface: ICustomEquivalence

Returns whether this object is equivalent to the given object. If the object is equivalent, it will not need to be updated during synchronization.

Specified by:

isEquivalent in interface ICustomEquivalence

Parameters:

obj - the object to compare with.

Returns:

true if the objects are equivalent, false otherwise.

getId

public java.lang.String getId()

setId

public void setId(java.lang.String id)

getParentPropertyBagId

public java.lang.String getParentPropertyBagId()

setParentPropertyBagId

public void setParentPropertyBagId(java.lang.String parentPropertyBagId)

getProperties

public java.util.List<Property> getProperties()

removeProperty

public java.lang.String removeProperty(java.lang.String propertyName)

removeProperties

public java.util.List<java.lang.String> removeProperties(java.lang.String propertyName)

Removes and returns the values of the given property.

Parameters:

propertyName - the property name.

Returns:

the stored values or null if there's no such property.

Since:

7.0.0

setDefaultValue

public void setDefaultValue(java.lang.String propertyName,
                            java.lang.String value)

setDefaultValue

public void setDefaultValue(java.lang.String propertyName,
                            java.lang.String value,
                            Property.InheritMode inheritMode)

Sets the default value.

Parameters:

propertyName - the property name.

value - the value.

inheritMode - the Property.InheritMode.

Since:

7.0.0

setDefaultValues

public void setDefaultValues(java.lang.String propertyName,
                             java.util.List<java.lang.String> values)

Sets the property default values.

Parameters:

propertyName - the property name.

values - the values.

Since:

7.0.0

setDefaultValues

public void setDefaultValues(java.lang.String propertyName,
                             java.util.List<java.lang.String> values,
                             Property.InheritMode inheritMode)

Sets the property default values.

Parameters:

propertyName - the property name.

values - the values.

inheritMode - the Property.InheritMode.

Since:

7.0.0

getValue

public java.lang.String getValue(java.lang.String propertyName)

Returns the value of the given property.

Parameters:

propertyName - the property name.

Returns:

the stored value or null if there's no such property.

Since:

7.0.0

getPropertyToSetValue

public Property getPropertyToSetValue(java.lang.String propertyName)

Returns the property to set value on.

Parameters:

propertyName - the property name.

Returns:

the property to set value on.

Since:

7.0.0