com.sapportals.wcm.repository

Interface IMutableProperty

All Superinterfaces:

IProperty

All Known Subinterfaces:

IMutableMultiLanguagedProperty

All Known Implementing Classes:

MutableMultiLanguagedProperty, MutableProperty

public interface IMutableProperty
extends IProperty

A property of a resource object with a mutable interface.

Method Summary

void	addValue(Object value) Adds a value to the list for a multi-value property
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 interface com.sapportals.wcm.repository.IProperty

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

Method Detail

setIntValue

void setIntValue(int value)
                 throws ResourceException

Sets the property value if the type ist PropertyType.INTEGER

Parameters:

value - The new value

Throws:

ResourceException

setDateValue

void setDateValue(Date value)
                  throws ResourceException

Sets the property value if the type ist PropertyType.DATE

Parameters:

value - The new value

Throws:

ResourceException

setDateValueFromLong

void setDateValueFromLong(long value)
                          throws ResourceException

Sets the property value if the type ist PropertyType.DATE

Parameters:

value - The new value

Throws:

ResourceException

setStringValue

void setStringValue(String value)
                    throws ResourceException

Sets the property value if the type ist PropertyType.STRING

Parameters:

value - The new value

Throws:

ResourceException

setLongIntValue

void setLongIntValue(long value)
                     throws ResourceException

Sets the property value if the type ist PropertyType.LONG

Parameters:

value - The new value

Throws:

ResourceException

setBooleanValue

void setBooleanValue(boolean value)
                     throws ResourceException

Sets the property value if the type ist PropertyType.BOOLEAN

Parameters:

value - The new value

Throws:

ResourceException

setValues

void setValues(List values)
               throws ResourceException

Sets all values of a multi-value property

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

void addValue(Object value)
              throws ResourceException

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

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

void setValue(int index,
              Object value)
              throws ResourceException

Set a value of a multi-value property

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

void removeValue(int index)
                 throws ResourceException

Remove a value of a multi-value property

Parameters:

index - The zero-based index

Throws:

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

setAttribute

void setAttribute(String name,
                  String value)
                  throws ResourceException

Set an attribute

Parameters:

name - Attribute name

value - Attribute value

Throws:

ResourceException

setAttributes

void setAttributes(Properties attributes)
                   throws ResourceException

Set the complete collection of attributes

Parameters:

attributes - All attributes

Throws:

ResourceException

removeAttribute

void removeAttribute(String name)
                     throws ResourceException

Removes a attribute

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