com.sap.portal.pcm

Interface IMutableAttributes

All Superinterfaces:

IAttributes

All Known Subinterfaces:

IApplicationPage, IAttributeSet, IiView, ILayout, IPage, ISystem

public interface IMutableAttributes
extends IAttributes

A mutable extension of the IAttributes interface. Adds methods to set and delete attributes and attribute values

See Also:

IAttributeSet

Field Summary

Fields inherited from interface com.sap.portal.pcm.IAttributes

ADMINISTRATION, ATTRIBUTE_NOT_FOUND, DIALOG, DIALOG_READ_ONLY, NONDIALOG, NONE, PERSONALIZATION, STRING_ATTRIBUTE, TEXT_ATTRIBUTE

Method Summary

void	deleteAttribute(String attributeId) Deletes an attribute, if it exists and is editable.
void	deleteMetaAttribute(String attributeId, String metaAttributeId) Deletes a meta-attribute if it exists and is editable.
void	putAttribute(String attributeId, Locale locale, String value) Replaces the value of a text-type attribute in the specified locale if it exists, adds the attribute if it does not exist, or adds the value if the locale does not exist.
void	putAttribute(String attributeId, String value) Replaces the value of a string-type attribute if it exists, or adds the attribute if it does not exist.
void	putMetaAttribute(String attributeId, String metaAttributeId, Locale locale, String value) Replaces the value of a text-type attribute in the specified locale if it exists, adds the attribute if it does not exist, or adds the value if the locale does not exist.
void	putMetaAttribute(String attributeId, String metaAttributeId, String value) Replaces the value of a string-type meta-attribute if it exists, or adds the meta-attribute if it does not exist.

Methods inherited from interface com.sap.portal.pcm.IAttributes

getAttribute, getAttribute, getAttributeIds, getAttributeType, getAvailableAttributeLocales, getAvailableMetaAttributeLocales, getMetaAttribute, getMetaAttribute, getMetaAttributeIds, getMetaAttributeType

Method Detail

deleteAttribute

void deleteAttribute(String attributeId)
                     throws UnsupportedOperationException

Deletes an attribute, if it exists and is editable.

Parameters:

attributeId - the ID of the attribute

Throws:

UnsupportedOperationException - if the object or attribute is not editable or if the attribute does not exist

putAttribute

void putAttribute(String attributeId,
                  String value)
                  throws UnsupportedOperationException

Replaces the value of a string-type attribute if it exists, or adds the attribute if it does not exist.

The changes are not saved until IAttributeSet.save() is called.

Parameters:

attributeId - the ID of the attribute

value - the new value

Throws:

UnsupportedOperationException - if the object is not editable or if the attribute is of type text

putAttribute

void putAttribute(String attributeId,
                  Locale locale,
                  String value)
                  throws UnsupportedOperationException

Replaces the value of a text-type attribute in the specified locale if it exists, adds the attribute if it does not exist, or adds the value if the locale does not exist.

The changes are not saved until IAttributeSet.save() is called.

Parameters:

attributeId - the ID of the attribute

locale - the preferred locale

value - the value assigned to the attribute for the specified locale

Throws:

UnsupportedOperationException - if this is a read-only object, or if the attribute is of type string

deleteMetaAttribute

void deleteMetaAttribute(String attributeId,
                         String metaAttributeId)

Deletes a meta-attribute if it exists and is editable.

Parameters:

attributeId - the ID of an attribute

metaAttributeId - the ID of the meta-attribute to be deleted

Throws:

UnsupportedOperationException - if the object or the attribute are not editable or if the attribute does not exist

See Also:

deleteAttribute(java.lang.String)

putMetaAttribute

void putMetaAttribute(String attributeId,
                      String metaAttributeId,
                      String value)
                      throws UnsupportedOperationException

Replaces the value of a string-type meta-attribute if it exists, or adds the meta-attribute if it does not exist.

The changes are not saved until IAttributeSet.save() is called.

Parameters:

attributeId - the ID of an attribute

metaAttributeId - the ID of the meta-attribute

value - the new value

Throws:

UnsupportedOperationException - if the object or attribute are not editable or if the meta-attribute is of type text

See Also:

putAttribute(java.lang.String, java.lang.String)

putMetaAttribute

void putMetaAttribute(String attributeId,
                      String metaAttributeId,
                      Locale locale,
                      String value)
                      throws UnsupportedOperationException

Replaces the value of a text-type attribute in the specified locale if it exists, adds the attribute if it does not exist, or adds the value if the locale does not exist.

The changes are not saved until IAttributeSet.save() is called.

Parameters:

attributeId - the ID of an attribute

metaAttributeId - the ID of the meta-attribute

locale - the locale of the value

value - the value assigned to the meta-attribute for the specified locale

Throws:

UnsupportedOperationException - if the object or meta-attribute are not editable or if the meta-attribute is of type string.

See Also:

putAttribute(java.lang.String, java.lang.String)

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] EP-BASIS-API	[sap.com] tc/epbc/pcm/admin/public/api	api	EP-PIN