PortletPersonalization 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
- public interface PortletPersonalization
extends com.bea.portal.model.PersonalizedResource
Interface PortletPersonalization
represents the personalization
of a Portlet for a given identity. In the same way that a
ProfileIdentity
can represent either a usergroup or a user
within a usergroup, so a PortletPersonalization
can represent
the personalization of a Portlet
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.MutablePortletPersonalization
public PortletPersonalizationIdentifier |
-
getIdentifier ()
- Returns the unique identifier for this
PortletPersonalization .
|
public PlaceholderIdentifier |
-
getPlaceholderIdentifier ()
- Returns the
PlaceholderIdentifier that represents the
placeholder that this portlet is currently positioned within
for this user on this page.
|
public int |
-
getPlaceholderIndex ()
- Returns the position of this portlet within its placholder.
|
public PortletIdentifier |
-
getPortletIdentifier ()
- Returns the identifier for the
Portlet that this is a
personalization of.
|
public Boolean |
-
isAvailable ()
- Determines whether this page is currently specified as Available for
this user or group.
|
public Boolean |
-
isDefaultStateMinimized ()
- Determines whether this page is currently specified as Default State
Minimized for this user or group.
|
public Boolean |
-
isEntitled ()
- Determines whether this page is currently specified as Entitled for
this user or group.
|
public Boolean |
-
isFloatable ()
- Determines whether this page is currently specified as Floatable for
this user or group.
|
public Boolean |
-
isMandatory ()
- Determines whether this page is currently specified as Mandatory for
this user or group.
|
public Boolean |
-
isMaximizable ()
- Determines whether this page is currently specified as Maximizable for
this user or group.
|
public Boolean |
-
isMinimizable ()
- Determines whether this page is currently specified as Minimizable for
this user or group.
|
public Boolean |
-
isMinimized ()
- Determines whether this page is currently Minimized for this user or group.
|
public Boolean |
-
isMovable ()
- Determines whether this page is currently specified as Movable for
this user or group.
|
public Boolean |
-
isVisible ()
- Determines whether this page is currently specified as Visible for
this user or group.
|
getIdentifier() Method
public PortletPersonalizationIdentifier
getIdentifier()
Returns the unique identifier for this
PortletPersonalization
.
Returns
- the unique identifier for this personalization.
getPlaceholderIdentifier() Method
public PlaceholderIdentifier
getPlaceholderIdentifier()
Returns the PlaceholderIdentifier
that represents the
placeholder that this portlet is currently positioned within
for this user on this page.
Returns
- the placeholder this portlet is within.
getPlaceholderIndex() Method
public int getPlaceholderIndex()
Returns the position of this portlet within its placholder.
Returns
- the position of this portlet within this placeholder.
getPortletIdentifier() Method
public PortletIdentifier
getPortletIdentifier()
Returns the identifier for the Portlet
that this is a
personalization of.
Returns
- the identifier for the associated portlet.
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).
isDefaultStateMinimized() Method
public Boolean
isDefaultStateMinimized()
Determines whether this page is currently specified as Default State
Minimized 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 Default State Minimized.
Returns
- whether the page is specified as Default State Minimized
(or unspecified).
isEntitled() Method
public Boolean
isEntitled()
Determines whether this page is currently specified as Entitled 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 Entitled.
Returns
- whether the page is specified as Entitled (or unspecified).
isFloatable() Method
public Boolean
isFloatable()
Determines whether this page is currently specified as Floatable 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 Floatable.
Returns
- whether the page is specified as Floatable (or unspecified).
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).
isMaximizable() Method
public Boolean
isMaximizable()
Determines whether this page is currently specified as Maximizable 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 Maximizable.
Returns
- whether the page is specified as Maximizable (or unspecified).
isMinimizable() Method
public Boolean
isMinimizable()
Determines whether this page is currently specified as Minimizable 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 Minimizable.
Returns
- whether the page is specified as Minimizable (or unspecified).
isMinimized() Method
public Boolean
isMinimized()
Determines whether this page is currently Minimized 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 Minimized.
Returns
- whether the page is specified as Minimized (or unspecified).
isMovable() Method
public Boolean
isMovable()
Determines whether this page is currently specified as Movable 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 Movable.
Returns
- whether the page is specified as Movable (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).