org.opencms.gwt.shared.property
Class CmsPropertyModification

java.lang.Object
  org.opencms.gwt.shared.property.CmsPropertyModification

All Implemented Interfaces:

com.google.gwt.user.client.rpc.IsSerializable

public class CmsPropertyModification
extends java.lang.Object
implements com.google.gwt.user.client.rpc.IsSerializable

A class which represents a property modification.

Since:

8.0.0

Constructor Summary

protected	CmsPropertyModification() Empty constructor for serialization.
	CmsPropertyModification(CmsPropertyModification propMod) Copy constructor.
	CmsPropertyModification(CmsUUID resourceId, java.lang.String propertyName, java.lang.String value, boolean isStructureValue) Creates a new property modification bean.
	CmsPropertyModification(java.lang.String path, java.lang.String value) Creates a new property modification bean.

Method Summary

CmsUUID	getId() Returns the id of the resource for which to change properties.
java.lang.String	getName() Returns the property name.
java.lang.String	getValue() Returns the new value.
boolean	isStructureValue() Flag which indicates a structure value change.
void	updatePropertyInMap(java.util.Map<java.lang.String,CmsClientProperty> props) Helper method for applying the change to a property map.

Methods inherited from class java.lang.Object

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

Constructor Detail

CmsPropertyModification

public CmsPropertyModification(CmsPropertyModification propMod)

Copy constructor.

Parameters:

propMod - the modification bean from which to copy the data

CmsPropertyModification

public CmsPropertyModification(CmsUUID resourceId,
                               java.lang.String propertyName,
                               java.lang.String value,
                               boolean isStructureValue)

Creates a new property modification bean.

Parameters:

resourceId - the resource id for which the property changed

propertyName - the name of the property

value - the new property value

isStructureValue - flag which indicates whether the structure value changed

CmsPropertyModification

public CmsPropertyModification(java.lang.String path,
                               java.lang.String value)

Creates a new property modification bean.

Parameters:

path - a path of the form id/propertyname/mode, where mode is either S for structure or R for resource

value - the new property value

CmsPropertyModification

protected CmsPropertyModification()

Empty constructor for serialization.

Method Detail

getId

public CmsUUID getId()

Returns the id of the resource for which to change properties.

Returns:

the id of ther resource for which to change properties

getName

public java.lang.String getName()

Returns the property name.

Returns:

the property name

getValue

public java.lang.String getValue()

Returns the new value.

Returns:

the new value

isStructureValue

public boolean isStructureValue()

Flag which indicates a structure value change.

Returns:

true if the structure value was changed

updatePropertyInMap

public void updatePropertyInMap(java.util.Map<java.lang.String,CmsClientProperty> props)

Helper method for applying the change to a property map.

Parameters:

props - a map of properties