com.ibm.portal.pcm.dialog.dcx
Interface DCXData

All Superinterfaces:

Disposable, java.io.Serializable

public interface DCXData
extends Disposable, java.io.Serializable

Interface for the Dialog Controller Context. All setter methods will throw NullPointerException, if the given key is null.

Since:

8.0.0

Method Summary

boolean	containsKey(javax.xml.namespace.QName key) Check if the DCX contains a value associated with the given key.
java.lang.Object	get(javax.xml.namespace.QName key) Returns the Object associated with the given key in the DCX.
<T> T	get(javax.xml.namespace.QName key, java.lang.Class<T> targetClass) Returns the Object associated with the given key in the DCX.
<T> T	get(javax.xml.namespace.QName key, java.lang.Class<T> targetClass, T defaultValue) Returns the object associated with the given key in the DCX.
void	put(javax.xml.namespace.QName key, java.lang.Object value) Stores the given value under the given key in the DCX.
void	remove(javax.xml.namespace.QName key) Removes a mapping from the DCX.
<T> T	remove(javax.xml.namespace.QName key, java.lang.Class<T> targetClass) Removes a mapping from the DCX.

Methods inherited from interface com.ibm.portal.Disposable

dispose

Method Detail

containsKey

boolean containsKey(javax.xml.namespace.QName key)

Check if the DCX contains a value associated with the given key.

Parameters:

key - The key to be used. Must not be null.

Returns:

true if a value is associated with key, else false

remove

void remove(javax.xml.namespace.QName key)

Removes a mapping from the DCX. This method will not return the object associated with the key, if there was an object.

Parameters:

key - The key to be used. Must not be null.

remove

<T> T remove(javax.xml.namespace.QName key,
             java.lang.Class<T> targetClass)

Removes a mapping from the DCX.

Parameters:

key - The key to be used. Must not be null.

targetClass - The class of the requested object.

Returns:

The object mapped to the removed key, may be null if no object was associated with this key.

put

void put(javax.xml.namespace.QName key,
         java.lang.Object value)

Stores the given value under the given key in the DCX.

Parameters:

key - The key to be used. Must not be null.

value - The value to be stored.

get

java.lang.Object get(javax.xml.namespace.QName key)
                     throws java.lang.IllegalStateException

Returns the Object associated with the given key in the DCX.

Parameters:

key - The key to look up. Must not be null.

Returns:

Object associated with the key or null.

Throws:

java.lang.IllegalStateException - In case the key is associated with a JAXB serialized value, since this method does not provide any target class information. Use get(QName, Class) instead to avoid such issues.

get

<T> T get(javax.xml.namespace.QName key,
          java.lang.Class<T> targetClass)
      throws java.lang.IllegalStateException

Returns the Object associated with the given key in the DCX.

Parameters:

key - The key to look up. Must not be null.

targetClass - The class of the requested object.

Returns:

Object associated with the key or null.

Throws:

java.lang.IllegalStateException - In case of an internal exception during JAXB processing.

get

<T> T get(javax.xml.namespace.QName key,
          java.lang.Class<T> targetClass,
          T defaultValue)
      throws java.lang.IllegalStateException

Returns the object associated with the given key in the DCX.

Parameters:

key - The key to look up. Must not be null.

targetClass - The class of the requested object.

defaultValue - The default value to return, if there is no value filed for the given key.

Returns:

Object associated with the key or defaultValue (which might be null).

Throws:

java.lang.IllegalStateException - In case of an internal exception during JAXB processing.