PortalPersonalization Interface

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

public interface PortalPersonalization

    extends com.bea.portal.model.PersonalizedResource

Interface PortalPersonalization represents the 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 PortalPersonalization can represent the personalization of a Portal for either a usergroup or a user within a usergroup.

All Superinterfaces
com.bea.portal.model.PersonalizedObject, com.bea.portal.model.PersonalizedResource, com.bea.portal.model.PortalResource, com.bea.portal.model.PortalScopedObject
All Known Subinterfaces

com.bea.portal.model.MutablePortalPersonalization

Method Summary
public PageIdentifier
getHomePage()
Returns a PageIdentifier representing the home page defined for this identity.
public PortalPersonalizationIdentifier
getIdentifier()
Returns the unique identifier for this PortalPersonalization.
public LayoutDefinition
getLayout(LayoutIdentifier layoutId)
Returns the LayoutDefinition requested by identifier.
public Map
getLayoutMap()
Returns a map of LayoutDefinition keyed with LayoutIdentifier.
public List
getLayouts()
Returns a List of LayoutDefinition objects for the layouts available for selection for this identity.
public int
getNavBarOrientation()
Returns the orientation of the navigation bar to be used when the portal is rendered for this user or group.
public PagePersonalization
getPagePersonalization(PageIdentifier pageId)
Returns a PagePersonalization object for the specified page and for the associated identity.
public Iterator
getPagePersonalizations()
Returns an Iterator over all the PagePersonalization objects in this portal for the associated identity.
public SkinIdentifier
getSelectedSkin()
Returns the selected skin for this user or group.
public SkinDefinition
getSkin(SkinIdentifier skinId)
Returns the SkinDefinition requested by identifier.
public Map
getSkinMap()
Returns a map of SkinDefinition keyed with SkinIdentifier.
public List
getSkins()
Returns a List of SkinIdentifier objects for the skins available for selection in this portal for this identity.
 
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.PortalResource
getResourceIdentifier
 
Methods from interface com.bea.portal.model.com.bea.portal.model.PortalScopedObject
getPortalIdentifier
   

Method Detail

getHomePage() Method

public PageIdentifier getHomePage()
Returns a PageIdentifier representing the home page defined for this identity. A value of null (only valid for a user customization) indicates that the user has not specified a home page.

Returns

specified home page.

getIdentifier() Method

public PortalPersonalizationIdentifier getIdentifier()
Returns the unique identifier for this PortalPersonalization.

Returns

the unique identifier for this personalization.

getLayout(LayoutIdentifier) Method

public LayoutDefinition getLayout(LayoutIdentifier layoutId)
Returns the LayoutDefinition requested by identifier.

Parameters

layoutId
identifier for layout required.

Returns

the layout definition requested.

getLayoutMap() Method

public Map getLayoutMap()
Returns a map of LayoutDefinition keyed with LayoutIdentifier.

Returns

map of layouts

getLayouts() Method

public List getLayouts()
Returns a List of LayoutDefinition objects for the layouts available for selection for this identity.

Returns

the set of layouts available to this identity.

getNavBarOrientation() Method

public int getNavBarOrientation()
Returns the orientation of the navigation bar to be used 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

Returns

the orientation of the navigation bar for this identity.

getPagePersonalization(PageIdentifier) Method

public PagePersonalization getPagePersonalization(PageIdentifier pageId)
Returns a PagePersonalization object for the specified page and for the associated identity.

Parameters

pageId
page for which a personalization is required.

Returns

the page personalization for the specified page.

getPagePersonalizations() Method

public Iterator getPagePersonalizations()
Returns an Iterator over all the PagePersonalization objects in this portal for the associated identity.

Returns

all the page personalizations in this portal .

getSelectedSkin() Method

public SkinIdentifier getSelectedSkin()
Returns the selected skin for this user or group. A value of null (only valid for a user customization) indicates that the user has not specified a skin.

Returns

the selected skin for this identitiy.

getSkin(SkinIdentifier) Method

public SkinDefinition getSkin(SkinIdentifier skinId)
Returns the SkinDefinition requested by identifier.

Parameters

skinId
identifier for skin required.

Returns

the skin definition requested.

getSkinMap() Method

public Map getSkinMap()
Returns a map of SkinDefinition keyed with SkinIdentifier.

Returns

map of skins

getSkins() Method

public List getSkins()
Returns a List of SkinIdentifier objects for the skins available for selection in this portal for this identity.

Returns

the set of skins available to this identity.