nl.gx.webmanager.springmvc
Interface CmsItemPrivateSession

All Known Implementing Classes:

CmsItemPrivateSessionImpl

public interface CmsItemPrivateSession

Provide an virtual Private http Session for an CmsItemBase Class

Author:

johntd

Method Summary

java.lang.String	getAttribute(java.lang.String key) get the attribute value with the given key from the "Virtual Private Session"
java.lang.String	getInstanceAttribute(java.lang.String instanceId, java.lang.String key) get the attribute value with the given key from the "Virtual Private Session" from this specific instanceId.
void	setAttribute(java.lang.String key, java.lang.String value) store a String attribute on the "Virtual Private Session" with the given key
void	setInstanceAttribute(java.lang.String instanceId, java.lang.String key, java.lang.String value) store a String attribute on the "Virtual Private Session" with the given key only visual for the given instanceId.

Method Detail

setAttribute

void setAttribute(java.lang.String key,
                  java.lang.String value)

store a String attribute on the "Virtual Private Session" with the given key

Parameters:

key - key may not start GX_ (framework internal)

value - value to store

getAttribute

java.lang.String getAttribute(java.lang.String key)

get the attribute value with the given key from the "Virtual Private Session"

Parameters:

key -

Returns:

requested attribute value or null if not found

setInstanceAttribute

void setInstanceAttribute(java.lang.String instanceId,
                          java.lang.String key,
                          java.lang.String value)

store a String attribute on the "Virtual Private Session" with the given key only visual for the given instanceId. This way attributes with the same key for multiple instances (f.e. values of an element instance, or usage of an "id" key on multiple tabs (user tabId form instanceId)

Parameters:

instanceId -

key - key may not start GX_ (framework internal)

value - value to store

getInstanceAttribute

java.lang.String getInstanceAttribute(java.lang.String instanceId,
                                      java.lang.String key)

get the attribute value with the given key from the "Virtual Private Session" from this specific instanceId.

Parameters:

instanceId -

key -

Returns:

requested attribute value or null if not found