DEPRECATED com.bea.portal is only useful in the compatibility domain. For the new portal framework please use the classes under the com.bea.netuix package

# com.bea.portal.model
UserPageState Interface

public interface UserPageState
extends `com.bea.portal.model.PortalResource`

Interface `UserPageState` represents the current state of a portal page with respect to a specific user session. All the data required to personalize the associated portal page should be available through this interface.

All Superinterfaces
  `com.bea.portal.model.PortalResource`, `com.bea.portal.model.PortalScopedObject`

## Method Summary

`public `LayoutIdentifier`` | `getLayoutIdentifier`() Method `getLayoutIdentifier` retrieves an identifier for the layout specified to be used to render this portal page.
`public `UserPageStateMetadata`` | `getMetadata`() Method `getMetadata` retrieves the metadata object associated with this user page state.
`public `PageIdentifier`` | `getPageIdentifier`() Method `getPageIdentifier` retrieves the identifier of the portal page that this object is the state of.
`public `List`` | `getPortletsForPlaceholder`(`String` placeholderId) Method `getPortletsForPlaceholder` retrieves the list of all `PortletIdentifier` objects that are associated with visible portlets situated within the supplied placeholder.
`public `UserPortletState`` | `getUserPortletState`(`PortletIdentifier` portletId) Method `getUserPortletState` retrieves an object representing the state of the specified portlet personalized for the associated user.
`public `HashMap`` | `getUserPortletStates`() Method `getAllUserPortletState` retrieves the list of all `UserPortletState` objects within this `UserPageState` NOTE: the definition of `UserPortalState` requires that only `USerPortletState` objects associated with visible portlets on the current page be maintained in the `UserPortalState`.

Methods from interface `com.bea.portal.model.`com.bea.portal.model.PortalResource``
``getResourceIdentifier``

Methods from interface `com.bea.portal.model.`com.bea.portal.model.PortalScopedObject``
``getPortalIdentifier``

## Method Detail

### getLayoutIdentifier() Method

    public LayoutIdentifier getLayoutIdentifier()

Method `getLayoutIdentifier` retrieves an identifier for the layout specified to be used to render this portal page. This identifier simply contains a String which maps to a subdirectory under the defined layout directory. All the extra resources required to render the layout template should be loaded from this directory. This data is associated to the user at user scope.

#### Returns

A value of type `LayoutIdentifier` used to specify the layout template to use to render this portal page.

### getMetadata() Method

    public UserPageStateMetadata getMetadata()

Method `getMetadata` retrieves the metadata object associated with this user page state.

#### Returns

A value of type `UserPageStateMetadata` used to specify the information such as the display name and index of the page.

### getPageIdentifier() Method

    public PageIdentifier getPageIdentifier()

Method `getPageIdentifier` retrieves the identifier of the portal page that this object is the state of.

#### Returns

A value of type `PageIdentifier` used to specify the portal page that this object is the state of.

### getPortletsForPlaceholder(String) Method

    public List getPortletsForPlaceholder(String placeholderId)

Method `getPortletsForPlaceholder` retrieves the list of all `PortletIdentifier` objects that are associated with visible portlets situated within the supplied placeholder.

#### Parameters

placeholderId
  parameter of type `String`used to specify the placeholder for which we should return portlet states.``

#### Returns

A value of type `List` containing the portlet states associated with visible portlets in the supplied placeholder.

### getUserPortletState(PortletIdentifier) Method

    public UserPortletState getUserPortletState(PortletIdentifier portletId)

Method `getUserPortletState` retrieves an object representing the state of the specified portlet personalized for the associated user.

NOTE: the definition of `UserPortalState` requires that only `UserPortletState` objects associated with visible portlets on the current page be maintained in the `PortalState`.

#### Parameters

portletId
  parameter of type `PortletIdentifier`used to specify the portlet type for which state is required.``

#### Returns

A value of type `UserPortletState` used to specify the state of the specified portlet for the associated user.

### getUserPortletStates() Method

    public HashMap getUserPortletStates()

Method `getAllUserPortletState` retrieves the list of all `UserPortletState` objects within this `UserPageState`

NOTE: the definition of `UserPortalState` requires that only `USerPortletState` objects associated with visible portlets on the current page be maintained in the `UserPortalState`.

#### Returns

A value of type `UserPortletState` used to specify the state of the specified portlet for the associated user.