Class PortletSession
java.lang.Object
com.appiancorp.suiteapi.web.portal.PortletSession
- All Implemented Interfaces:
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:
-
Method Summary
Modifier and TypeMethodDescriptiongetAttribute
(String name) Get the value of a given attribute.Get all the attributes as a map.boolean
getNew()
Determine whether the current portlet is newly created.removeAttribute
(String name) Remove a given attribute.void
setAttribute
(String name, Object value) Set the value of a given attribute.
-
Method Details
-
setAttribute
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
Get the value of a given attribute.- Parameters:
name
- The name of the attribute to get.- Returns:
- The value of the attribute.
-
removeAttribute
Remove a given attribute.- Parameters:
name
- The name of the attribute to remove.- Returns:
- The value of the attribute removed.
-
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.
-