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
UserPortalState Interface

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

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

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

## Method Summary

`public `UserPageState`` | `getCurrentUserPageState`() Method `getCurrentUserPageState` retrieves an object representing the state of the portal page currently selected by the associated user.
`public `String`` | `getDisplayName`() Method `getDisplayName` retrieves the personalized display name of the associated portal.
`public int` | `getNavBarOrientation`() Method `getNavBarOrientation` retrieves the currently selected navigation bar orientation for the associated user.
`public `PortalIdentifier`` | `getPortalIdentifier`() Method `getPortalIdentifier` retrieves the identifier of the portal that this object is the state of.
`public `SkinDefinition`` | `getSkin`() Method `getSkinIdentifier` retrieves the currently selected skin for the associated user.
`public `UserPageStateMetadata`` | `getUserPageStateMetadata`(`PageIdentifier` pageId) Method `getUserPageStateMetadata` retrieves the list of `UserPageStateMetadata` objects for pages contained within this `UserPortalState`.
`public `HashMap`` | `getUserPageStateMetadata`() Method `getUserPageStateMetadata` retrieves the list of `UserPageStateMetadata` objects for pages contained within this `UserPortalState`.

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

## Method Detail

### getCurrentUserPageState() Method

    public UserPageState getCurrentUserPageState()

Method `getCurrentUserPageState` retrieves an object representing the state of the portal page currently selected by the associated user.

#### Returns

A value of type `UserPageState` used to specify the state of the current portal page for the associated user.

### getDisplayName() Method

    public String getDisplayName()

Method `getDisplayName` retrieves the personalized display name of the associated portal. This data is personalized to the associated user at group scope.

#### Returns

A value of type `String` used to describe the portal to the associated user.

### getNavBarOrientation() Method

    public int getNavBarOrientation()

Method `getNavBarOrientation` retrieves the currently selected navigation bar orientation for the associated user. This data is personalized to the associated user at user scope.

#### Returns

A value of type `int` used to specify the currently selected navigation bar orientation for the associated user. Allowed values: Portal.NAVBAR_ORIENTATION_UNSPECIFIED, Portal.NAVBAR_ORIENTATION_VERTICAL, Portal.NAVBAR_ORIENTATION_HORIZONTAL.

### getPortalIdentifier() Method

    public PortalIdentifier getPortalIdentifier()

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

#### Returns

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

### getSkin() Method

    public SkinDefinition getSkin()

Method `getSkinIdentifier` retrieves the currently selected skin for the associated user. This data is personalized to the associated user at user scope.

#### Returns

A value of type `SkinIdentifier` used to specify the currently selected skin for the associated user.

### getUserPageStateMetadata(PageIdentifier) Method

    public UserPageStateMetadata getUserPageStateMetadata(PageIdentifier pageId)

Method `getUserPageStateMetadata` retrieves the list of `UserPageStateMetadata` objects for pages contained within this `UserPortalState`.

NOTE: the definition of `UserPortalState` requires that only `UserPageStateMetadata` objects associated with visible `Page` objects be maintained in the `UserPortalState`.

#### Returns

A value of type `List` containing objects of type `UserPageState` representing the state of all visible portal pages for the associated user.

### getUserPageStateMetadata() Method

    public HashMap getUserPageStateMetadata()

Method `getUserPageStateMetadata` retrieves the list of `UserPageStateMetadata` objects for pages contained within this `UserPortalState`.

NOTE: the definition of `UserPortalState` requires that only `UserPageStateMetadata` objects associated with visible `Page` objects be maintained in the `UserPortalState`.

#### Returns

A value of type `List` containing objects of type `UserPageState` representing the state of all visible portal pages for the associated user.