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

public interface PagePersonalization

    extends com.bea.portal.model.PersonalizedResource

Interface PagePersonalization represents the personalization of a Page for a given identity. In the same way that a ProfileIdentity can represent either a usergroup or a user within a usergroup, so a PagePersonalization can represent the personalization of a Page 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.MutablePagePersonalization

Method Summary
public String
getDisplayType()
public PagePersonalizationIdentifier
getIdentifier()
Returns the unique identifier for this PagePersonalization.
public int
getIndex()
Returns the index of this page for this user or group, determining the order in which the tab for this page appears during rendering.
public LayoutIdentifier
getLayout()
Returns the layout template to be used on this page for this user or group.
public List
getLayouts()
Returns a List of LayoutIdentifier objects for the layouts available for selection on this page.
public PageIdentifier
getPageIdentifier()
Returns the identifier for the Page that this is a personalization of.
public PortletPersonalization
getPortletPersonalization(PortletIdentifier portletId)
Returns the PortletPersonalization corresponding to the PortletIdentifier specified or null if not found.
public Iterator
getPortletPersonalizations()
Returns an Iterator over the set of PortletPersonalizations that are contained by this page for this identity.
public Boolean
isAvailable()
Determines whether this page is currently specified as available for this user or group.
public Boolean
isDisplayMutable()
public Boolean
isEntitled()
Determines whether this page currently has any entitlements defined against it.
public Boolean
isMandatory()
Determines whether this page is currently specified as mandatory for this user or group.
public Boolean
isVisible()
Determines whether this page is currently specified as visible for this user or group.
 
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

getDisplayType() Method

public String getDisplayType()

getIdentifier() Method

public PagePersonalizationIdentifier getIdentifier()
Returns the unique identifier for this PagePersonalization.

Returns

the unique identifier for this personalization.

getIndex() Method

public int getIndex()
Returns the index of this page for this user or group, determining the order in which the tab for this page appears during rendering. This value should be a natural number. A value of -1 indicates unspecified. Note: This value must always be specified for group personalizations but is allowed to be -1 for a user personalization.

Returns

an int representing the index of this page.

getLayout() Method

public LayoutIdentifier getLayout()
Returns the layout template to be used on this page for this user or group. A value of null (only valid for a user customization) indicates that the user has not specified a layout.

getLayouts() Method

public List getLayouts()
Returns a List of LayoutIdentifier objects for the layouts available for selection on this page.

Note: This is only be defined for group personalizations and will return null for a user personalization.

Returns

the set of layouts available for this page.

getPageIdentifier() Method

public PageIdentifier getPageIdentifier()
Returns the identifier for the Page that this is a personalization of.

Returns

the identifier for the associated page.

getPortletPersonalization(PortletIdentifier) Method

public PortletPersonalization getPortletPersonalization(PortletIdentifier portletId)
Returns the PortletPersonalization corresponding to the PortletIdentifier specified or null if not found.

Parameters

portletId
identifier for portlet personalization required.

Returns

the PortletPersonalization specified.

getPortletPersonalizations() Method

public Iterator getPortletPersonalizations()
Returns an Iterator over the set of PortletPersonalizations that are contained by this page for this identity.

Returns

the portlet personalizations on this page.

isAvailable() Method

public Boolean isAvailable()
Determines whether this page is currently specified as available for this user or group. A value of null (only valid for a user customization) indicates that the user has not specified whether or not this page should be available.

Returns

whether the page is specified as available (or unspecified).

isDisplayMutable() Method

public Boolean isDisplayMutable()

isEntitled() Method

public Boolean isEntitled()
Determines whether this page currently has any entitlements defined against it.

Returns

whether the page has any entitlements defined.

isMandatory() Method

public Boolean isMandatory()
Determines whether this page is currently specified as mandatory for this user or group. A value of null (only valid for a user customization) indicates that the user has not specified whether or not this page should be mandatory.

Returns

whether the page is specified as mandatory (or unspecified).

isVisible() Method

public Boolean isVisible()
Determines whether this page is currently specified as visible for this user or group. A value of null (only valid for a user customization) indicates that the user has not specified whether or not this page should be visible.

Returns

whether the page is specified as visible (or unspecified).