com.ibm.portal
Interface ModifiableMetaData

All Superinterfaces:

ListModel, MetaData, Modifiable

All Known Subinterfaces:

ModifiableLayoutMetrics, ModifiablePortletPreferences

public interface ModifiableMetaData
extends MetaData, Modifiable

An interface representing modifiable meta data. It can be obtained through the ModifiableMetaDataProvider.

Since:

6.1.0

Method Summary

boolean	confirmRemoveName(java.lang.String aName) Indicates if the specifed meta data may be removed.
boolean	confirmRemoveNames() Indicates if all meta data may be removed.
boolean	confirmRemoveNames(java.util.Collection aCollection) Indicates if the specified meta data may be removed.
boolean	confirmRetainNames(java.util.Collection aCollection) Indicates if the specified meta data may be retained.
boolean	confirmSetValue(java.lang.String aName, java.lang.Object aValue) Indicates if the specified meta data may be set.
boolean	confirmSetValues(MetaData aMetaData) Indicates if the specified meta data may be set.
java.lang.Object	removeName(java.lang.String aName) Removes the meta data identified with the specified name.
boolean	removeNames() Removes all meta data.
boolean	removeNames(java.util.Collection aCollection) Removes the meta data identified by the names specified in the collection.
boolean	retainNames(java.util.Collection aCollection) Retains only the meta data identified by the names specified in the collection.
java.lang.Object	setValue(java.lang.String aName, java.lang.Object aValue) Sets the value for the meta data identified by the specified name.
boolean	setValues(MetaData aMetaData) Sets the specified meta data.

Methods inherited from interface com.ibm.portal.MetaData

getNames, getValue, iterator

Method Detail

setValue

java.lang.Object setValue(java.lang.String aName,
                          java.lang.Object aValue)
                          throws CannotModifyPropertyException

Sets the value for the meta data identified by the specified name.

Parameters:

aName - name of meta data to set the value for

aValue - meta data value to set; must not be null

Returns:

the former value for the name; if none existed, null is returned

Throws:

CannotModifyPropertyException - in case the value of the meta data cannot be set

setValues

boolean setValues(MetaData aMetaData)
                  throws CannotModifyPropertyException

Sets the specified meta data.

Parameters:

aMetaData - meta data to set

Returns:

true if this ModifiableMetaData was changed as a result of this call

Throws:

CannotModifyPropertyException - in case a specified meta data cannot be set; in this case, the meta data are set only partially

removeName

java.lang.Object removeName(java.lang.String aName)
                            throws CannotModifyPropertyException

Removes the meta data identified with the specified name.

Parameters:

aName - name of meta data to remove

Returns:

the former value for the name; if none existed, null is returned

Throws:

CannotModifyPropertyException - in case the meta data cannot be removed

removeNames

boolean removeNames(java.util.Collection aCollection)
                    throws CannotModifyPropertyException

Removes the meta data identified by the names specified in the collection.

Parameters:

aCollection - collection of names of meta data to remove

Returns:

true if this ModifiableMetaData was changed as a result of this call

Throws:

CannotModifyPropertyException - in case a specified meta data cannot be removed; in this case, the meta data are removed only partially

removeNames

boolean removeNames()
                    throws CannotModifyPropertyException

Removes all meta data.

Returns:

true if this ModifiableMetaData was changed as a result of this call

Throws:

CannotModifyPropertyException - in case a meta data cannot be removed; in this case, the meta data are removed only partially

retainNames

boolean retainNames(java.util.Collection aCollection)
                    throws CannotModifyPropertyException

Retains only the meta data identified by the names specified in the collection.

Parameters:

aCollection - names of meta data to retain

Returns:

true if this ModifiableMetaData was changed as a result of this call

Throws:

CannotModifyPropertyException - in case a meta data, which is not to be retained, cannot be removed; in this case, the meta data is removed only partially.

confirmSetValue

boolean confirmSetValue(java.lang.String aName,
                        java.lang.Object aValue)

Indicates if the specified meta data may be set.

Parameters:

aName - name identifying the meta data for which to indicate if the specified value may be set

aValue - meta data value for which to indicate if it may be set

Returns:

true if the meta data may be set, false otherwise

confirmSetValues

boolean confirmSetValues(MetaData aMetaData)

Indicates if the specified meta data may be set.

Parameters:

aMetaData - meta data for which to indicate if it may be set

Returns:

true if the specfied meta data may be set, false otherwise

confirmRemoveName

boolean confirmRemoveName(java.lang.String aName)

Indicates if the specifed meta data may be removed.

Parameters:

aName - name identifying the meta data

Returns:

true if the specified meta data may be removed, false otherwise

confirmRemoveNames

boolean confirmRemoveNames(java.util.Collection aCollection)

Indicates if the specified meta data may be removed.

Parameters:

aCollection - collection of names identifying meta data for which to indicate if they may be removed

Returns:

true if the specified meta data may be removed, false otherwise

confirmRemoveNames

boolean confirmRemoveNames()

Indicates if all meta data may be removed.

Returns:

true if all meta data may be remvoed, false otherwise

confirmRetainNames

boolean confirmRetainNames(java.util.Collection aCollection)

Indicates if the specified meta data may be retained.

Parameters:

aCollection - collection of names identifying meta data for which to indicate if they may be retained

Returns:

true in case the meta data may be retained, false otherwise