com.appiancorp.suiteapi.web.portal

Class PortletSession

java.lang.Object

com.appiancorp.suiteapi.web.portal.PortletSession

All Implemented Interfaces:

java.io.Serializable

public class PortletSession
extends java.lang.Object
implements java.io.Serializable

Encapsulates HTTP session attributes that are specific to a given portlet. Each portlet has its own dedicated space in which to store session attributes.

See Also:

Serialized Form

Method Summary

Modifier and Type	Method and Description
java.lang.Object	getAttribute(java.lang.String name) Get the value of a given attribute.
java.util.Map	getAttributes() Get all the attributes as a map.
boolean	getNew() Determine whether the current portlet is newly created.
java.lang.Object	removeAttribute(java.lang.String name) Remove a given attribute.
void	setAttribute(java.lang.String name, java.lang.Object value) Set the value of a given attribute.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

setAttribute

public void setAttribute(java.lang.String name,
                         java.lang.Object value)

Set the value of a given attribute.

Parameters:

name - The name under which to store the value.

value - The value to store under the name.

getAttribute

public java.lang.Object getAttribute(java.lang.String name)

Get the value of a given attribute.

Parameters:

name - The name of the attribute to get.

Returns:

The value of the attribute.

removeAttribute

public java.lang.Object removeAttribute(java.lang.String name)

Remove a given attribute.

Parameters:

name - The name of the attribute to remove.

Returns:

The value of the attribute removed.

getAttributes

public java.util.Map getAttributes()

Get all the attributes as a map.

Returns:

The map.

getNew

public boolean getNew()

Determine whether the current portlet is newly created.

Returns:

true if it is, false if not.