com.ibm.xsp.model
Interface DataObject

All Known Implementing Classes:

ComponentParameters, DominoDocument

public interface DataObject

DataObject

This is an interface that any object can implement to expose themselves to JSF EL.

Method Summary

java.lang.Class<?>	getType(java.lang.Object key) Return the type of a property.
java.lang.Object	getValue(java.lang.Object key) Returns the value to which this data object maps the specified key.
boolean	isReadOnly(java.lang.Object key) Return true if the value associated with the specified key is known to be immutable; otherwise, return false.
void	setValue(java.lang.Object key, java.lang.Object value) Associates the specified value with the specified key in this data object (optional operation).

Method Detail

getValue

java.lang.Object getValue(java.lang.Object key)

Returns the value to which this data object maps the specified key.

Parameters:

key - key whose associated value is to be returned.

Returns:

the value to which this data object maps the specified key, or null if the data object contains no mapping for this key.

Throws:

java.lang.ClassCastException - if the key is of an inappropriate type for this data object (optional).

java.lang.NullPointerException - key is null and this data object does not not permit null keys (optional).

setValue

void setValue(java.lang.Object key,
              java.lang.Object value)

Associates the specified value with the specified key in this data object (optional operation).

Parameters:

key - key with which the specified value is to be associated.

value - value to be associated with the specified key.

Throws:

java.lang.UnsupportedOperationException - if the put operation is not supported by this data object.

java.lang.ClassCastException - if the class of the specified key or value prevents it from being stored in this data object.

java.lang.IllegalArgumentException - if some aspect of this key or value prevents it from being stored in this data object.

java.lang.NullPointerException - this data object does not permit null keys or values, and the specified key or value is null.

getType

java.lang.Class<?> getType(java.lang.Object key)

Return the type of a property.

Parameters:

key - key with which the specified value is to be associated.

Returns:

the type to which this data object maps the specified key, or null if the data object contains no mapping for this key (or undefined)

isReadOnly

boolean isReadOnly(java.lang.Object key)

Return true if the value associated with the specified key is known to be immutable; otherwise, return false.

Parameters:

key - key of the specified value to be tested.

Returns:

true if the specified data object is known to be immutable; otherwise, return false.