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

public interface UserPageStateMetadata

Interface `UserPageStateMetadata` represents the dynamic data about a page which is required for rendering.

## Method Summary

`public `String`` | `getDisplayName`() Method `getDisplayName` retrieves the personalized display name of the associated portal page.
`public `String`` | `getDisplayType`()
`public int` | `getIndex`() Method `getIndex` returns an integer representing the position of this page in the ordering of all portal pages.
`public `PageIdentifier`` | `getPageIdentifier`() Method `getPageIdentifier` retrieves the identifier of the portal page that this object is the state of.
`public `Boolean`` | `isDisplayMutable`()

## Method Detail

### getDisplayName() Method

    public String getDisplayName()

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

#### Returns

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

### getDisplayType() Method

    public String getDisplayType()

### getIndex() Method

    public int getIndex()

Method `getIndex` returns an integer representing the position of this page in the ordering of all portal pages.

#### Returns

A value of primitive type `int` representing the position of this portal 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.

### isDisplayMutable() Method

    public Boolean isDisplayMutable()