Overview | Package | Class | Tree | Deprecated | Index | Help
| © 2002 BEA Systems, Inc.
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## com.bea.portal.model
Interface MutablePortalPersonalization

public interface MutablePortalPersonalization
extends PortalPersonalization, MutablePersonalizedObject

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.

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

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

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

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

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

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

Method Detail

### setHomePage

    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.

### setSelectedSkin

    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.

### setSkins

    public void setSkins(java.util.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.

### setSkinMap

    public void setSkinMap(java.util.Map skins)

### setLayouts

    public void setLayouts(java.util.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.

### setLayoutMap

    public void setLayoutMap(java.util.Map layouts)

### setSkin

    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.

### setLayout

    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.

### setNavBarOrientation

    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

    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:
    `a` - `PagePersonalization` to add to this portal.

### setPagePersonalizationMap

    public void setPagePersonalizationMap(java.util.HashMap pageP13ns)

### setPagePersonalizations

    public void setPagePersonalizations(java.util.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.

### getMutablePagePersonalization

    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:
    `the` - page for which a personalization is required.
  Returns:
    the page personalization for the specified page.

### getMutablePagePersonalizations

    public java.util.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 .

Overview | Package | Class | Tree | Deprecated | Index | Help
| © 2002 BEA Systems, Inc.
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Copyright © 2002 BEA Systems, Inc. All Rights Reserved