com.crystaldecisions.sdk.properties
Interface IProperties

All Superinterfaces:
java.util.Map

public interface IProperties
extends java.util.Map

This interface defines a collection of properties.


Method Summary
 IProperty add(java.lang.Object id, java.lang.Object value, int flags)
           Adds a new property to the collection.
 IProperty getProperty(java.lang.Object id)
           Returns the specified property.
 void setProperty(java.lang.Object id, boolean value)
           Sets the property's value as a boolean.
 void setProperty(java.lang.Object id, int value)
           Sets the property's value as an int.
 void setProperty(java.lang.Object id, long value)
           Sets the property's value as a long.
 void setProperty(java.lang.Object id, java.lang.Object value)
           Sets the property's value.
 
Methods inherited from interface java.util.Map
clear, containsKey, containsValue, entrySet, equals, get, hashCode, isEmpty, keySet, put, putAll, remove, size, values
 

Method Detail

add

public IProperty add(java.lang.Object id,
                     java.lang.Object value,
                     int flags)

Adds a new property to the collection. If the flag is set to IProperty.BAG, a new, empty property bag is added.

Parameters:
id - The ID of the property.
value - The value of the property to be added.
flags - The flag to be used.
Returns:
An IProperty object containing the requested property.
See Also:

getProperty

public IProperty getProperty(java.lang.Object id)

Returns the specified property.

Parameters:
id - The ID of the property to be returned.
Returns:
An IProperty object containing the requested property.

setProperty

public void setProperty(java.lang.Object id,
                        java.lang.Object value)

Sets the property's value.

Parameters:
id - The ID of the property to be set.
value - The value that the property should be set to.

setProperty

public void setProperty(java.lang.Object id,
                        int value)

Sets the property's value as an int.

Parameters:
id - The ID of the property to be set.
value - The value that the property should be set to.

setProperty

public void setProperty(java.lang.Object id,
                        long value)

Sets the property's value as a long.

Parameters:
id - The ID of the property to be set.
value - The value that the property should be set to.

setProperty

public void setProperty(java.lang.Object id,
                        boolean value)

Sets the property's value as a boolean.

Parameters:
id - The ID of the property to be set.
value - The value that the property should be set to.