com.bea.portal.model
Interface PagePersonalization

All Known Subinterfaces:

MutablePagePersonalization

public interface PagePersonalization

extends 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.

Method Summary

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

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

getIdentifier

public PagePersonalizationIdentifier getIdentifier()

Returns the unique identifier for this PagePersonalization.

Returns:

the unique identifier for this personalization.

getPageIdentifier

public PageIdentifier getPageIdentifier()

Returns the identifier for the Page that this is a personalization of.

Returns:

the identifier for the associated page.

getLayout

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.

Parameters:

layout - a unique identifier for the layout selected.

getLayouts

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

getIndex

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.

getPortletPersonalization

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

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

public java.lang.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).

isMandatory

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

public java.lang.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).

isEntitled

public java.lang.Boolean isEntitled()

Determines whether this page currently has any entitlements defined against it.

Returns:

whether the page has any entitlements defined.

isDisplayMutable

public java.lang.Boolean isDisplayMutable()

getDisplayType

public java.lang.String getDisplayType()