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

public interface MutablePortalPersonalization
extends `com.bea.portal.model.MutablePersonalizedObject`, `com.bea.portal.model.PortalPersonalization`

Interface `MutablePortalPersonalization` represents an editable personalization of a `Portal` for a given identity.In the same way that a `ProfileIdentity` can represent either a usergroup or a user within a usergroup, so a `MutablePortalPersonalization` can represent the mutable personalization of a `Portal` for either a usergroup or a user within a usergroup.

Note: Changes made to objects implementing this interface are only expected to change the local state of the object. To persist updates this object would have to be passed to an appropriate service, such as the `PortalManager` EJB.

All Superinterfaces
  `com.bea.portal.model.MutablePersonalizedObject`, `com.bea.portal.model.PersonalizedObject`, `com.bea.portal.model.PersonalizedResource`, `com.bea.portal.model.PortalPersonalization`, `com.bea.portal.model.PortalResource`, `com.bea.portal.model.PortalScopedObject`

## Method Summary

`public `MutablePagePersonalization`` | `getMutablePagePersonalization`(`PageIdentifier` pageId) Returns a `MutablePagePersonalization` object for the specified page and for the associated user.
`public `Iterator`` | `getMutablePagePersonalizations`() Returns an `Iterator` over all the `MutablePagePersonalization` objects in this portal for the associated user.
`public void` | `setHomePage`(`PageIdentifier` homePage) Specifies the page to use as a home page for this user or group.
`public void` | `setLayout`(`LayoutDefinition` layout) Adds the specified `LayoutDefinition` to the set of layouts available for selection.
`public void` | `setLayoutMap`(`Map` layouts)
`public void` | `setLayouts`(`List` layouts) Specifies the global set of layouts available to be selected for this user or group, and their associated display names.
`public void` | `setNavBarOrientation`(int navBarOrientation) Specifies the orientation of the navigation bar when the portal is rendered for this user or group.
`public void` | `setPagePersonalization`(`PagePersonalization` pageP13n) Sets a `PagePersonalization` to be contained within this portal.
`public void` | `setPagePersonalizationMap`(`HashMap` pageP13ns)
`public void` | `setPagePersonalizations`(`List` pageList) Sets the complete set of `PagePersonalization`s to be contained in this portal.
`public void` | `setSelectedSkin`(`SkinIdentifier` skinId) Specifies the skin to use as the selected skin for this user or group.
`public void` | `setSkin`(`SkinDefinition` skin) Adds the specified `SkinDefinition` to the set of skins available for selection.
`public void` | `setSkinMap`(`Map` skins)
`public void` | `setSkins`(`List` skins) Specifies the set of skins available to be selected for this user or group, and their associated display names.

Methods from interface `com.bea.portal.model.`com.bea.portal.model.MutablePersonalizedObject``
``setDisplayName``

Methods from interface `com.bea.portal.model.`com.bea.portal.model.PersonalizedObject``
``getDisplayName`, `getProfileIdentity``

Methods from interface `com.bea.portal.model.`com.bea.portal.model.PortalPersonalization``
``getHomePage`, `getIdentifier`, `getLayout`, `getLayoutMap`, `getLayouts`, `getNavBarOrientation`, `getPagePersonalization`, `getPagePersonalizations`, `getSelectedSkin`, `getSkin`, `getSkinMap`, `getSkins``

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

### getMutablePagePersonalization(PageIdentifier) Method

    public MutablePagePersonalization getMutablePagePersonalization(PageIdentifier pageId)

Returns a `MutablePagePersonalization` object for the specified page and for the associated user. If there is no existing such personalization for this user then a blank one is created, added to the list of contained personalizations, and returned.

#### Parameters

pageId
  page for which a personalization is required.

#### Returns

the page personalization for the specified page.

### getMutablePagePersonalizations() Method

    public Iterator getMutablePagePersonalizations()

Returns an `Iterator` over all the `MutablePagePersonalization` objects in this portal for the associated user.

#### Returns

all the page personalizations in this portal .

### setHomePage(PageIdentifier) Method

    public void setHomePage(PageIdentifier homePage)

Specifies the page to use as a home page for this user or group.

#### Parameters

homePage
  a `PageIdentifier` specifying the home page to use for this identity.

### setLayout(LayoutDefinition) Method

    public void setLayout(LayoutDefinition layout)

Adds the specified `LayoutDefinition` to the set of layouts available for selection.

#### Parameters

layout
  a `LayoutDefinition` to add to the available list.

### setLayoutMap(Map) Method

    public void setLayoutMap(Map layouts)

### setLayouts(List) Method

    public void setLayouts(List layouts)

Specifies the global set of layouts available to be selected for this user or group, and their associated display names. (Note: To be selected for a specific page a layout must also be available to that page.)

#### Parameters

layouts
  a `List` of `LayoutDefinition`s available for selection.

### setNavBarOrientation(int) Method

    public void setNavBarOrientation(int navBarOrientation)

Specifies the orientation of the navigation bar when the portal is rendered for this user or group. Valid values are: `Portal.NAVBAR_ORIENTATION_UNSPECIFIED` `Portal.NAVBAR_ORIENTATION_HORIZONTAL` `Portal.NAVBAR_ORIENTATION_VERTICAL`

#### Parameters

navBarOrientation
  the orientation of the navigation bar for this user.

### setPagePersonalization(PagePersonalization) Method

    public void setPagePersonalization(PagePersonalization pageP13n)

Sets a `PagePersonalization` to be contained within this portal. If this `PagePersonalization` already exists on this portal (identity being established by comparison of associated `Identifier` objects) then it is replaced, otherwise it is added.

#### Parameters

pageP13n
  `PagePersonalization` to add to this portal.

### setPagePersonalizationMap(HashMap) Method

    public void setPagePersonalizationMap(HashMap pageP13ns)

### setPagePersonalizations(List) Method

    public void setPagePersonalizations(List pageList)

Sets the complete set of `PagePersonalization`s to be contained in this portal. Any existing `PagePersonalization` objects are removed.

#### Parameters

pageList
  the list of page personalizations to set.

### setSelectedSkin(SkinIdentifier) Method

    public void setSelectedSkin(SkinIdentifier skinId)

Specifies the skin to use as the selected skin for this user or group.

#### Parameters

skinId
  a `SkinIdentifier` representing the skin to set for this identity.

### setSkin(SkinDefinition) Method

    public void setSkin(SkinDefinition skin)

Adds the specified `SkinDefinition` to the set of skins available for selection.

#### Parameters

skin
  a `SkinDefinition` to add to the available list.

### setSkinMap(Map) Method

    public void setSkinMap(Map skins)

### setSkins(List) Method

    public void setSkins(List skins)

Specifies the set of skins available to be selected for this user or group, and their associated display names.

#### Parameters

skins
  a `List` of `SkinDefinition`s available for selection.