com.sapportals.wcm.repository

Class MutableProperty

java.lang.Object
  com.sapportals.wcm.WcmObject
      com.sapportals.wcm.repository.Property
          com.sapportals.wcm.repository.MutableProperty

All Implemented Interfaces:

IMutableProperty, IProperty, Serializable

public class MutableProperty
extends Property
implements IMutableProperty, Serializable

A property of a resource object that can be modified

See Also:

Serialized Form

Field Summary

Fields inherited from class com.sapportals.wcm.repository.Property

m_attributes, m_dateValue, m_res, m_value, m_value_object, m_values

Fields inherited from class com.sapportals.wcm.WcmObject

ORDER_TYPE_MANUAL, ORDER_TYPE_NONE

Constructor Summary

	MutableProperty(IPropertyName name, Boolean value) Construct a new property of type BOOLEAN.
	MutableProperty(IPropertyName name, Boolean value, Properties attributes) Construct a new property of type BOOLEAN.
	MutableProperty(IPropertyName name, Date value) Construct a new property of type DATE.
	MutableProperty(IPropertyName name, Date value, Properties attributes) Construct a new property of type DATE.
	MutableProperty(IPropertyName name, Integer value) Construct a new property of type INTEGER.
	MutableProperty(IPropertyName name, Integer value, Properties attributes) Construct a new property of type INTEGER.
	MutableProperty(IPropertyName name, IPropertyDef def, Boolean value) Construct a new property of type BOOLEAN.
	MutableProperty(IPropertyName name, IPropertyDef def, Boolean value, Properties attributes) Construct a new property of type BOOLEAN.
	MutableProperty(IPropertyName name, IPropertyDef def, Date value) Construct a new property of type DATE.
	MutableProperty(IPropertyName name, IPropertyDef def, Date value, Properties attributes) Construct a new property of type DATE.
	MutableProperty(IPropertyName name, IPropertyDef def, Integer value) Construct a new property of type INTEGER.
	MutableProperty(IPropertyName name, IPropertyDef def, Integer value, Properties attributes) Construct a new property of type INTEGER.
	MutableProperty(IPropertyName name, IPropertyDef def, List values) Construct a new multi-valued property.
	MutableProperty(IPropertyName name, IPropertyDef def, List values, Properties attributes) Construct a new multi-valued property.
	MutableProperty(IPropertyName name, IPropertyDef def, Long value) Construct a new property of type LONG.
	MutableProperty(IPropertyName name, IPropertyDef def, Long value, Properties attributes) Construct a new property of type LONG.
	MutableProperty(IPropertyName name, IPropertyDef def, Object value) Construct a new property.
	MutableProperty(IPropertyName name, IPropertyDef def, Object value, Properties attributes) Construct a new property.
	MutableProperty(IPropertyName name, IPropertyDef def, String value) Construct a new property of type STRING.
	MutableProperty(IPropertyName name, IPropertyDef def, String value, Properties attributes) Construct a new property of type STRING.
	MutableProperty(IPropertyName name, IPropertyDef def, XMLMarkup value) Construct a new property of type XML.
	MutableProperty(IPropertyName name, IPropertyDef def, XMLMarkup value, Properties attributes) Construct a new property of type XML.
	MutableProperty(IPropertyName name, Long value) Construct a new property of type LONG.
	MutableProperty(IPropertyName name, Long value, Properties attributes) Construct a new property of type LONG.
	MutableProperty(IPropertyName name, Object value) Construct a new property.
	MutableProperty(IPropertyName name, Object value, Properties attributes) Construct a new property.
	MutableProperty(IPropertyName name, PropertyType type, List values) Construct a new multi-valued property.
	MutableProperty(IPropertyName name, PropertyType type, List values, Properties attributes) Construct a new multi-valued property.
	MutableProperty(IPropertyName name, String value) Construct a new property of type STRING.
	MutableProperty(IPropertyName name, String value, Properties attributes) Construct a new property of type STRING.
	MutableProperty(IPropertyName name, XMLMarkup value) Construct a new property of type XML.
	MutableProperty(IPropertyName name, XMLMarkup value, Properties attributes) Construct a new property of type XML.
protected	MutableProperty(Property p) Construct a new mutable property from a read-only property.

Method Summary

void	addValue(Object value) Adds a value to the list for a multi-value property
IMutableProperty	getMutable() Returns a copy of this propertry that can be modified
void	removeAttribute(String name) Removes a attribute
void	removeValue(int index) Remove a value of a multi-value property
void	setAttribute(String name, String value) Set an attribute
void	setAttributes(Properties attributes) Set the complete collection of attributes
void	setBooleanValue(boolean value) Sets the property value if the type ist PropertyType.BOOLEAN
void	setDateValue(Date value) Sets the property value if the type ist PropertyType.DATE
void	setDateValueFromLong(long value) Sets the property value if the type ist PropertyType.DATE
void	setIntValue(int value) Sets the property value if the type ist PropertyType.INTEGER
void	setLongIntValue(long value) Sets the property value if the type ist PropertyType.LONG
void	setStringValue(String value) Sets the property value if the type ist PropertyType.STRING
void	setValue(int index, Object value) Set a value of a multi-value property
void	setValues(List values) Sets all values of a multi-value property

Methods inherited from class com.sapportals.wcm.repository.Property

createContentLanguageProp, createContentLengthProp, createContentTypeProp, createCreatedByProp, createCreationDateProp, createDescriptionProp, createDisplaynameProp, createETagProp, createHiddenProp, createLastModifiedByProp, createLastModifiedProp, createPropertyFromStringValue, createReadOnlyProp, createResourceTypeProp, equals, getAttribute, getAttributes, getBooleanValue, getDateValue, getDateValueRaw, getDescription, getDescription, getIntValue, getLongIntValue, getPropertyDef, getPropertyName, getStringValue, getType, getValue, getValueAsString, getValues, hashCode, isMultivalued, isSystemProperty, toString, validateType

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.sapportals.wcm.repository.IProperty

getAttribute, getAttributes, getBooleanValue, getDateValue, getDescription, getDescription, getIntValue, getLongIntValue, getPropertyDef, getPropertyName, getStringValue, getType, getValue, getValueAsString, getValues, isMultivalued

Constructor Detail

MutableProperty

protected MutableProperty(Property p)

Construct a new mutable property from a read-only property. This is used in Property.getMutable().

Parameters:

p - TBD: Description of the incoming method parameter

MutableProperty

public MutableProperty(IPropertyName name,
                       String value)
                throws ResourceException

Construct a new property of type STRING.

Parameters:

name - The property name

value - The property string value

Throws:

ResourceException - Exception raised in failure situation

MutableProperty

public MutableProperty(IPropertyName name,
                       Date value)
                throws ResourceException

Construct a new property of type DATE.

Parameters:

name - The property name

value - The property date value

Throws:

ResourceException - Exception raised in failure situation

MutableProperty

public MutableProperty(IPropertyName name,
                       Boolean value)
                throws ResourceException

Construct a new property of type BOOLEAN.

Parameters:

name - The property name

value - The property booelan value

Throws:

ResourceException - Exception raised in failure situation

MutableProperty

public MutableProperty(IPropertyName name,
                       Integer value)
                throws ResourceException

Construct a new property of type INTEGER.

Parameters:

name - The property name

value - The property integer value

Throws:

ResourceException - Exception raised in failure situation

MutableProperty

public MutableProperty(IPropertyName name,
                       Long value)
                throws ResourceException

Construct a new property of type LONG.

Parameters:

name - The property name

value - The property long value

Throws:

ResourceException - Exception raised in failure situation

MutableProperty

public MutableProperty(IPropertyName name,
                       XMLMarkup value)
                throws ResourceException

Construct a new property of type XML.

Parameters:

name - The property name

value - The property xml value

Throws:

ResourceException - Exception raised in failure situation

MutableProperty

public MutableProperty(IPropertyName name,
                       PropertyType type,
                       List values)
                throws ResourceException

Construct a new multi-valued property.

Parameters:

name - The property name

type - The property data type

values - A list of values. The list must contain suitable object instances (String, Date, Integer, Long, Boolean, XMLMarkup) for the specified property type.

Throws:

ResourceException - If the instance of the value does not match the property type

MutableProperty

public MutableProperty(IPropertyName name,
                       Object value)
                throws ResourceException

Construct a new property. The value object's instance must be one of String, Integer, Long, Boolean, Date or XMLMarkup.

Parameters:

name - The property name

value - The value object

Throws:

ResourceException - If the instance of the value parameter is not allowed

MutableProperty

public MutableProperty(IPropertyName name,
                       IPropertyDef def,
                       String value)
                throws ResourceException

Construct a new property of type STRING.

Parameters:

name - The property name

def - The property definition

value - The property string value

Throws:

ResourceException - Exception raised in failure situation

MutableProperty

public MutableProperty(IPropertyName name,
                       IPropertyDef def,
                       Date value)
                throws ResourceException

Construct a new property of type DATE.

Parameters:

name - The property name

def - The property definition

value - The property string value

Throws:

ResourceException - Exception raised in failure situation

MutableProperty

public MutableProperty(IPropertyName name,
                       IPropertyDef def,
                       Boolean value)
                throws ResourceException

Construct a new property of type BOOLEAN.

Parameters:

name - The property name

def - The property definition

value - The property string value

Throws:

ResourceException - Exception raised in failure situation

MutableProperty

public MutableProperty(IPropertyName name,
                       IPropertyDef def,
                       Integer value)
                throws ResourceException

Construct a new property of type INTEGER.

Parameters:

name - The property name

def - The property definition

value - The property string value

Throws:

ResourceException - Exception raised in failure situation

MutableProperty

public MutableProperty(IPropertyName name,
                       IPropertyDef def,
                       Long value)
                throws ResourceException

Construct a new property of type LONG.

Parameters:

name - The property name

def - The property definition

value - The property string value

Throws:

ResourceException - Exception raised in failure situation

MutableProperty

public MutableProperty(IPropertyName name,
                       IPropertyDef def,
                       XMLMarkup value)
                throws ResourceException

Construct a new property of type XML.

Parameters:

name - The property name

def - The property definition

value - The property string value

Throws:

ResourceException - Exception raised in failure situation

MutableProperty

public MutableProperty(IPropertyName name,
                       IPropertyDef def,
                       Object value)
                throws ResourceException

Construct a new property. The value object's instance must be one of String, Integer, Long, Boolean, Date or XMLMarkup and must match the PropertyDef's type.

Parameters:

name - The property name

def - The property definition

value - The value object

Throws:

ResourceException - If the instance of the value parameter is not allowed or does not matach the type

MutableProperty

public MutableProperty(IPropertyName name,
                       IPropertyDef def,
                       List values)
                throws ResourceException

Construct a new multi-valued property.

Parameters:

name - The property name

def - The property definition

values - A list of values. The list must contain suitable object instances (String, Date, Integer, Long, Boolean, XMLMarkup) for the specified property type.

Throws:

ResourceException - If the instance of the value does not match the property type

MutableProperty

public MutableProperty(IPropertyName name,
                       String value,
                       Properties attributes)
                throws ResourceException

Construct a new property of type STRING.

Parameters:

name - The property name

value - The property string value

attributes - TBD: Description of the incoming method parameter

Throws:

ResourceException - Exception raised in failure situation

MutableProperty

public MutableProperty(IPropertyName name,
                       Date value,
                       Properties attributes)
                throws ResourceException

Construct a new property of type DATE.

Parameters:

name - The property name

value - The property date value

attributes - TBD: Description of the incoming method parameter

Throws:

ResourceException - Exception raised in failure situation

MutableProperty

public MutableProperty(IPropertyName name,
                       Boolean value,
                       Properties attributes)
                throws ResourceException

Construct a new property of type BOOLEAN.

Parameters:

name - The property name

value - The property booelan value

attributes - TBD: Description of the incoming method parameter

Throws:

ResourceException - Exception raised in failure situation

MutableProperty

public MutableProperty(IPropertyName name,
                       Integer value,
                       Properties attributes)
                throws ResourceException

Construct a new property of type INTEGER.

Parameters:

name - The property name

value - The property integer value

attributes - TBD: Description of the incoming method parameter

Throws:

ResourceException - Exception raised in failure situation

MutableProperty

public MutableProperty(IPropertyName name,
                       Long value,
                       Properties attributes)
                throws ResourceException

Construct a new property of type LONG.

Parameters:

name - The property name

value - The property long value

attributes - TBD: Description of the incoming method parameter

Throws:

ResourceException - Exception raised in failure situation

MutableProperty

public MutableProperty(IPropertyName name,
                       XMLMarkup value,
                       Properties attributes)
                throws ResourceException

Construct a new property of type XML.

Parameters:

name - The property name

value - The property xml value

attributes - TBD: Description of the incoming method parameter

Throws:

ResourceException - Exception raised in failure situation

MutableProperty

public MutableProperty(IPropertyName name,
                       Object value,
                       Properties attributes)
                throws ResourceException

Construct a new property. The value object's instance must be one of String, Integer, Long, Boolean, Date or XMLMarkup.

Parameters:

name - The property name

value - The value object

attributes - TBD: Description of the incoming method parameter

Throws:

ResourceException - If the instance of the value parameter is not allowed

MutableProperty

public MutableProperty(IPropertyName name,
                       PropertyType type,
                       List values,
                       Properties attributes)
                throws ResourceException

Construct a new multi-valued property.

Parameters:

name - The property name

type - The property data type

values - A list of values. The list must contain suitable object instances (String, Date, Integer, Long, Boolean, XMLMarkup) for the specified property type.

attributes - TBD: Description of the incoming method parameter

Throws:

ResourceException - If the instance of the value does not match the property type

MutableProperty

public MutableProperty(IPropertyName name,
                       IPropertyDef def,
                       String value,
                       Properties attributes)
                throws ResourceException

Construct a new property of type STRING.

Parameters:

name - The property name

def - The property definition

value - The property string value

attributes - TBD: Description of the incoming method parameter

Throws:

ResourceException - Exception raised in failure situation

MutableProperty

public MutableProperty(IPropertyName name,
                       IPropertyDef def,
                       Date value,
                       Properties attributes)
                throws ResourceException

Construct a new property of type DATE.

Parameters:

name - The property name

def - The property definition

value - The property string value

attributes - TBD: Description of the incoming method parameter

Throws:

ResourceException - Exception raised in failure situation

MutableProperty

public MutableProperty(IPropertyName name,
                       IPropertyDef def,
                       Boolean value,
                       Properties attributes)
                throws ResourceException

Construct a new property of type BOOLEAN.

Parameters:

name - The property name

def - The property definition

value - The property string value

attributes - TBD: Description of the incoming method parameter

Throws:

ResourceException - Exception raised in failure situation

MutableProperty

public MutableProperty(IPropertyName name,
                       IPropertyDef def,
                       Integer value,
                       Properties attributes)
                throws ResourceException

Construct a new property of type INTEGER.

Parameters:

name - The property name

def - The property definition

value - The property string value

attributes - TBD: Description of the incoming method parameter

Throws:

ResourceException - Exception raised in failure situation

MutableProperty

public MutableProperty(IPropertyName name,
                       IPropertyDef def,
                       Long value,
                       Properties attributes)
                throws ResourceException

Construct a new property of type LONG.

Parameters:

name - The property name

def - The property definition

value - The property string value

attributes - TBD: Description of the incoming method parameter

Throws:

ResourceException - Exception raised in failure situation

MutableProperty

public MutableProperty(IPropertyName name,
                       IPropertyDef def,
                       XMLMarkup value,
                       Properties attributes)
                throws ResourceException

Construct a new property of type XML.

Parameters:

name - The property name

def - The property definition

value - The property string value

attributes - TBD: Description of the incoming method parameter

Throws:

ResourceException - Exception raised in failure situation

MutableProperty

public MutableProperty(IPropertyName name,
                       IPropertyDef def,
                       Object value,
                       Properties attributes)
                throws ResourceException

Construct a new property. The value object's instance must be one of String, Integer, Long, Boolean, Date or XMLMarkup and must match the PropertyDef's type.

Parameters:

name - The property name

def - The property definition

value - The value object

attributes - TBD: Description of the incoming method parameter

Throws:

ResourceException - If the instance of the value parameter is not allowed or does not matach the type

MutableProperty

public MutableProperty(IPropertyName name,
                       IPropertyDef def,
                       List values,
                       Properties attributes)
                throws ResourceException

Construct a new multi-valued property.

Parameters:

name - The property name

def - The property definition

values - A list of values. The list must contain suitable object instances (String, Date, Integer, Long, Boolean, XMLMarkup) for the specified property type.

attributes - TBD: Description of the incoming method parameter

Throws:

ResourceException - If the instance of the value does not match the property type

Method Detail

setIntValue

public void setIntValue(int value)
                 throws ResourceException

Description copied from interface: IMutableProperty

Sets the property value if the type ist PropertyType.INTEGER

Specified by:

setIntValue in interface IMutableProperty

Parameters:

value - The new value

Throws:

ResourceException

setDateValue

public void setDateValue(Date value)
                  throws ResourceException

Description copied from interface: IMutableProperty

Sets the property value if the type ist PropertyType.DATE

Specified by:

setDateValue in interface IMutableProperty

Parameters:

value - The new value

Throws:

ResourceException

setDateValueFromLong

public void setDateValueFromLong(long value)
                          throws ResourceException

Description copied from interface: IMutableProperty

Sets the property value if the type ist PropertyType.DATE

Specified by:

setDateValueFromLong in interface IMutableProperty

Parameters:

value - The new value

Throws:

ResourceException

setStringValue

public void setStringValue(String value)
                    throws ResourceException

Description copied from interface: IMutableProperty

Sets the property value if the type ist PropertyType.STRING

Specified by:

setStringValue in interface IMutableProperty

Parameters:

value - The new value

Throws:

ResourceException

setLongIntValue

public void setLongIntValue(long value)
                     throws ResourceException

Description copied from interface: IMutableProperty

Sets the property value if the type ist PropertyType.LONG

Specified by:

setLongIntValue in interface IMutableProperty

Parameters:

value - The new value

Throws:

ResourceException

setBooleanValue

public void setBooleanValue(boolean value)
                     throws ResourceException

Description copied from interface: IMutableProperty

Sets the property value if the type ist PropertyType.BOOLEAN

Specified by:

setBooleanValue in interface IMutableProperty

Parameters:

value - The new value

Throws:

ResourceException

setValues

public void setValues(List values)
               throws ResourceException

Description copied from interface: IMutableProperty

Sets all values of a multi-value property

Specified by:

setValues in interface IMutableProperty

Parameters:

values - The new values. The following table shows the instance that has to be used for each type. PropertyType | instanceof ------------------------- STRING | String BOOLEAN | Boolean INTEGER | Integer LONG | Long DATE | Date XML | String

Throws:

ResourceException - If the property is not defined as multi-valued If a instance of a value does not match the property type

addValue

public void addValue(Object value)
              throws ResourceException

Description copied from interface: IMutableProperty

Adds a value to the list for a multi-value property

Specified by:

addValue in interface IMutableProperty

Parameters:

value - The value to add. The following table shows the instance that has to be used for each type. PropertyType | instanceof ------------------------- STRING | String BOOLEAN | Boolean INTEGER | Integer LONG | Long DATE | Date XML | String

Throws:

ResourceException - If the property is not defined as multi-valued If the instance of the value does not match the property type

setValue

public void setValue(int index,
                     Object value)
              throws ResourceException

Description copied from interface: IMutableProperty

Set a value of a multi-value property

Specified by:

setValue in interface IMutableProperty

Parameters:

index - The zero-based index

value - The new value

Throws:

ResourceException - If the property is not defined as multi-valued If the instance of the value does not match the property type If the index it out of bounds

removeValue

public void removeValue(int index)
                 throws ResourceException

Description copied from interface: IMutableProperty

Remove a value of a multi-value property

Specified by:

removeValue in interface IMutableProperty

Parameters:

index - The zero-based index

Throws:

ResourceException - If the property is not defined as multi-valued If the index it out of bounds

getMutable

public IMutableProperty getMutable()

Description copied from interface: IProperty

Returns a copy of this propertry that can be modified

Specified by:

getMutable in interface IProperty

Overrides:

getMutable in class Property

Returns:

A mutable property instance

setAttribute

public void setAttribute(String name,
                         String value)
                  throws ResourceException

Description copied from interface: IMutableProperty

Set an attribute

Specified by:

setAttribute in interface IMutableProperty

Parameters:

name - Attribute name

value - Attribute value

Throws:

ResourceException

setAttributes

public void setAttributes(Properties attributes)
                   throws ResourceException

Description copied from interface: IMutableProperty

Set the complete collection of attributes

Specified by:

setAttributes in interface IMutableProperty

Parameters:

attributes - All attributes

Throws:

ResourceException

removeAttribute

public void removeAttribute(String name)
                     throws ResourceException

Description copied from interface: IMutableProperty

Removes a attribute

Specified by:

removeAttribute in interface IMutableProperty

Parameters:

name - Attribute name

Throws:

ResourceException

Access Rights

This class can be accessed from:

SC	DC	Public Part	ACH
[sap.com] KMC-CM	[sap.com] tc/km/frwk	api	EP-KM-CM
[sap.com] KMC-WPC	[sap.com] tc/kmc/wpc/wpcfacade	api	EP-PIN-WPC-WCM