com.ibm.portal.state.accessors.statepartition
Interface StatePartitionAccessor

All Superinterfaces:

Accessor, Disposable

All Known Subinterfaces:

StatePartitionAccessorController

public interface StatePartitionAccessor
extends Accessor

Interface providing read access to the state partition information in the state holder. Provides a method to read the state partition identifier. This identifier should be used to scope data on a per browser window basis in the session.

The state partition identifier is used to partition a user session into sub-sessions. This is needed when accessing the portal via a second browser window like in pop-up winodws. If a portlet is opened in a separate pop-up window, then it is the responsibility of the portlet developer to take care for closing the pop-up, for instance after the user pushed a button. Setting "CloseWindow" as the theme template of the state partition will close the pop-up if the CloseWindow.jsp is available in the selected theme. Custom JavaScript code is another possibility to close a pop-up window. In this case session timeouts needs to be handled by custom code too.

Since:

5.1

Method Summary

java.lang.String

getStatePartitionId() Returns the state partition identifier (if any).

Methods inherited from interface com.ibm.portal.Disposable

dispose

Method Detail

getStatePartitionId

java.lang.String getStatePartitionId()

Returns the state partition identifier (if any).

Returns:

The String representing the state partition identifier or null.