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

public interface MutablePagePersonalization

    extends com.bea.portal.model.MutablePersonalizedObject, com.bea.portal.model.PagePersonalization

Interface MutablePagePersonalization represents an editable 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 MutablePagePersonalization can represent the mutable personalization of a Page 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 (or an object that contains it) 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.PagePersonalization, com.bea.portal.model.PersonalizedObject, com.bea.portal.model.PersonalizedResource, com.bea.portal.model.PortalResource, com.bea.portal.model.PortalScopedObject

Method Summary

public MutablePortletPersonalization
getMutablePortletPersonalization(PortletIdentifier portletId)
Returns a MutablePortletPersonalization object for the specified portlet on this page for the associated user.
public Iterator
getMutablePortletPersonalizations()
Returns an Iterator over all the MutablePortletPersonalization objects on this page for the associated user.
public void
setAvailable(Boolean available)
Sets whether this page is currently specified as available for this user or group.
public void
setDisplayMutable(Boolean displayMutable)
public void
setDisplayName(String displayName)
Sets a display name for this resource suitable to be displayed to a user.
public void
setDisplayType(String displayType)
public void
setIndex(int index)
Sets the index of this page for this user or group, determining the order in which the tab for this page appears during rendering.
public void
setLayout(LayoutIdentifier layout)
Sets the layout template to be used on this page for this user or group.
public void
setLayouts(List layouts)
Sets the List of objects representing the allowed set of layouts selectable users in this group on this page.
public void
setMandatory(Boolean mandatory)
Sets whether this page is currently specified as mandatory for this user or group.
public void
setPortletPersonalization(PortletPersonalization portletP13n)
Sets a PortletPersonalization to be contained within this page.
public void
setPortletPersonalizations(List portletList)
Sets the complete set of PortletPersonalizations to be contained on this page.
public void
setVisible(Boolean visible)
Sets whether this page is currently specified as visible for this user or group.
 
Methods from interface com.bea.portal.model.com.bea.portal.model.PagePersonalization
getDisplayType, getIdentifier, getIndex, getLayout, getLayouts, getPageIdentifier, getPortletPersonalization, getPortletPersonalizations, isAvailable, isDisplayMutable, isEntitled, isMandatory, isVisible
 
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

getMutablePortletPersonalization(PortletIdentifier) Method

public MutablePortletPersonalization getMutablePortletPersonalization(PortletIdentifier portletId)
Returns a MutablePortletPersonalization object for the specified portlet on this page 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.

Returns

the portlet personalization for the specified portlet.

getMutablePortletPersonalizations() Method

public Iterator getMutablePortletPersonalizations()
Returns an Iterator over all the MutablePortletPersonalization objects on this page for the associated user.

Returns

all the portlet personalizations on this page.

setAvailable(Boolean) Method

public void setAvailable(Boolean available)
Sets 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.

Parameters

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

setDisplayMutable(Boolean) Method

public void setDisplayMutable(Boolean displayMutable)

setDisplayName(String) Method

public void setDisplayName(String displayName)
Description copied from MutablePersonalizedObject.setDisplayName(String)
Sets a display name for this resource suitable to be displayed to a user.

Parameters

displayName
display name for this resource.

setDisplayType(String) Method

public void setDisplayType(String displayType)

setIndex(int) Method

public void setIndex(int index)
Sets 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 null for a user personalization.

Parameters

index
an int representing the position of this page.

setLayout(LayoutIdentifier) Method

public void setLayout(LayoutIdentifier layout)
Sets the layout template to be used on this page for this user or group.

Parameters

layout
a unique identifier for the layout selected.

setLayouts(List) Method

public void setLayouts(List layouts)
Sets the List of objects representing the allowed set of layouts selectable users in this group on this page.

Note: This should only be defined for group personalizations and should be null for a user personalization.

Parameters

layouts
a List of LayoutIdentifier objects.

setMandatory(Boolean) Method

public void setMandatory(Boolean mandatory)
Sets 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.

Parameters

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

setPortletPersonalization(PortletPersonalization) Method

public void setPortletPersonalization(PortletPersonalization portletP13n)
Sets a PortletPersonalization to be contained within this page. If this PortletPersonalization already exists on this page (identity being established by comparison of associated Identifier objects) then it is replaced, otherwise it is added.

Parameters

portletP13n
PortletPersonalization to add to this page.

setPortletPersonalizations(List) Method

public void setPortletPersonalizations(List portletList)
Sets the complete set of PortletPersonalizations to be contained on this page. Any existing PortletPersonalization objects are removed.

Parameters

portletList
the list of portlet personalizations to set.

setVisible(Boolean) Method

public void setVisible(Boolean visible)
Sets 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.

Parameters

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