|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface GroupSession
Interface for a consumer based group session.A group session is used to hold portlet session objects of portlet instances which belong to the same group of the same producer according to their portlet description.
Method Summary | |
---|---|
void |
addPortletSession(PortletSession portletSession)
Add a portlet session to this group session. |
boolean |
existsPortletSession(java.lang.String instanceKey)
Check if the group session holds a portlet session with the given key. |
java.util.Iterator |
getAllPortletSessions()
Get all portlet session objects currently stored in the group session. |
java.lang.String |
getGroupID()
Get the ID of the group this group session belongs to. |
PortletSession |
getPortletSession(java.lang.String instanceKey)
Get the portlet session object which is identified with the givven instanceKey from the group session. |
void |
removeAllPortletSessions()
Removes all portlet session objects from the group session. |
void |
removePortletSession(java.lang.String instanceKey)
Remove the portlet session object with the given key from the group session. |
void |
setGroupID(java.lang.String groupID)
Set the ID of the group this group session belongs to. |
Method Detail |
---|
java.lang.String getGroupID()
PortletSession getPortletSession(java.lang.String instanceKey)
instanceKey
- The key which identifies the portlet session object
java.util.Iterator getAllPortletSessions()
boolean existsPortletSession(java.lang.String instanceKey)
void setGroupID(java.lang.String groupID)
groupID
- ID of the groupvoid addPortletSession(PortletSession portletSession)
portletSession
- The portlet session which should be
added to this group session.void removePortletSession(java.lang.String instanceKey)
instanceKey
- Key which identifies the portlet session object to be removed.void removeAllPortletSessions()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |