com.sap.netweaver.bc.rf.common.property

Interface IMutableProperty

All Superinterfaces:

IProperty

All Known Implementing Classes:

MutableBooleanMultiValueProperty, MutableBooleanSingleValueProperty, MutableDateMultiValueProperty, MutableDateSingleValueProperty, MutableIntMultiValueProperty, MutableIntSingleValueProperty, MutableLongMultiValueProperty, MutableLongSingleValueProperty, MutableStringMultiValueProperty, MutableStringSingleValueProperty, MutableXmlMultiValueProperty, MutableXmlSingleValueProperty

public interface IMutableProperty
extends IProperty

Read-And-Write interface describing a property, which is part of the resource and describes certain aspects of it. A property has a name (IPropertyName), type (PropertyType), some attributes, a natural language description and most important a value. For each type exists a specific property interface and implementation extending this interface.

See Also:

IProperty, IPropertyName, PropertyType

Method Summary

void	clearAttributes() Remove all attributes for the property at once.
void	removeAttribute(String attributeName) Remove attribute from the property.
void	setAttribute(String attributeName, String attributeValue) Add attribute for the property.
void	setAttributes(Properties attributes) Set all attributes for the property at once.

Methods inherited from interface com.sap.netweaver.bc.rf.common.property.IProperty

areFlagsSet, getAttribute, getAttributes, getDescription, getDescription, getFlags, getPropertyName, getType, getValueAsString, getValuesAsStrings, isHidden, isLive, isMultiValue, isReadOnly, isRequired

Method Detail

setAttributes

void setAttributes(Properties attributes)
                   throws ResourceException

Set all attributes for the property at once. The given attribute map will be stored directly (as is - without being copied). Note that this call disconnects the attribute map returned from a getAttributes() call from the property.

Parameters:

attributes - property map holding all attributes

Throws:

ResourceException - when the attributes map or the property is invalid

clearAttributes

void clearAttributes()
                     throws ResourceException

Remove all attributes for the property at once.

Throws:

ResourceException - when the property is invalid

setAttribute

void setAttribute(String attributeName,
                  String attributeValue)
                  throws ResourceException

Add attribute for the property.

Parameters:

attributeName - attribute name

attributeValue - attribute value

Throws:

ResourceException - when the attribute name or value or the property is invalid

removeAttribute

void removeAttribute(String attributeName)
                     throws ResourceException

Remove attribute from the property.

Parameters:

attributeName - attribute name

Throws:

ResourceException - when the attribute name or the property is invalid

Access Rights

This class can be accessed from:

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