UserPortletState 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 UserPortletState
extends com.bea.portal.model.PortalResource
Interface UserPortletState
represents the current state of a portlet
with respect to a specific user session. All the data required
to personalize the associated portlet should be available through this
interface.
-
All Superinterfaces
-
com.bea.portal.model.PortalResource
, com.bea.portal.model.PortalScopedObject
public String |
-
getDisplayName ()
- Method
getDisplayName returns the display
name of this portlet.
|
public PlaceholderIdentifier |
-
getPlaceholderIdentifier ()
- Method
getPlaceholderIdentifier retrieves an identifier
for the placeholder that this portlet instance is currently situated
within.
|
public int |
-
getPlaceholderIndex ()
- Method
getPlaceholderIndex retrieves an index representing
an ordering for this portlet within the placeholder that is specified by
the getPlaceholderIdentifier method.
|
public PortletIdentifier |
-
getPortletIdentifier ()
- Method
getPortletIdentifier retrieves an identifier
representing the portlet definition that this portlet is an instance of.
|
public boolean |
-
isEditable ()
- Method
isEditable determines whether this portlet
currently has the 'editable' attribute set for this user.
|
public boolean |
-
isFloatable ()
- Method
isFloatable determines whether this portlet
currently has the 'floatable' attribute set for this user.
|
public boolean |
-
isHelpable ()
- Method
isHelpable determines whether this portlet
currently has the 'helpable' attribute set for this user.
|
public boolean |
-
isMaximizable ()
- Method
isMaximizable determines whether this portlet
currently has the 'maximizable' attribute set for this user.
|
public boolean |
-
isMinimizable ()
- Method
isMinimizable determines whether this portlet
currently has the 'minimizable' attribute set for this user.
|
public boolean |
-
isMinimized ()
- Method
isMinimized determines whether a this portlet is
currently in a minimized state.
|
public boolean |
-
isRemovable ()
- Method
isRemovable determines whether this portlet
currently has the 'removable' attribute set for this user.
|
getDisplayName() Method
public String
getDisplayName()
Method getDisplayName
returns the display
name of this portlet.
Returns
- A value of type
String
representing the
name of this portlet.
getPlaceholderIdentifier() Method
public PlaceholderIdentifier
getPlaceholderIdentifier()
Method getPlaceholderIdentifier
retrieves an identifier
for the placeholder that this portlet instance is currently situated
within. This data is personalized to the associated user at user scope.
Returns
- A value of type
PlaceholderIdentifier
representing the
placeholder that this portlet instance is currently located within.
getPlaceholderIndex() Method
public int getPlaceholderIndex()
Method getPlaceholderIndex
retrieves an index representing
an ordering for this portlet within the placeholder that is specified by
the getPlaceholderIdentifier
method. The index is expected
to start at 1 with 0 representing an unspecified index.
Returns
- A value of primitive type
int
representing index of
this portlet within the specified placeholder.
getPortletIdentifier() Method
public PortletIdentifier
getPortletIdentifier()
Method getPortletIdentifier
retrieves an identifier
representing the portlet definition that this portlet is an instance of.
Returns
- A value of type
PortletIdentifier
representing the
portlet definition that this portlet is an instance of
isEditable() Method
public boolean isEditable()
Method isEditable
determines whether this portlet
currently has the 'editable' attribute set for this user.
Returns
- A value of type
boolean
representing whether
this portlet has the 'editable' attribute set for this user.
isFloatable() Method
public boolean isFloatable()
Method isFloatable
determines whether this portlet
currently has the 'floatable' attribute set for this user.
Returns
- A value of type
boolean
representing whether
this portlet has the 'floatable' attribute set for this user.
isHelpable() Method
public boolean isHelpable()
Method isHelpable
determines whether this portlet
currently has the 'helpable' attribute set for this user.
Returns
- A value of type
boolean
representing whether
this portlet has the 'helpable' attribute set for this user.
isMaximizable() Method
public boolean isMaximizable()
Method isMaximizable
determines whether this portlet
currently has the 'maximizable' attribute set for this user.
Returns
- A value of type
boolean
representing whether
this portlet has the 'maximizable' attribute set for this user.
isMinimizable() Method
public boolean isMinimizable()
Method isMinimizable
determines whether this portlet
currently has the 'minimizable' attribute set for this user.
Returns
- A value of type
boolean
representing whether
this portlet has the 'minimizable' attribute set for this user.
isMinimized() Method
public boolean isMinimized()
Method isMinimized
determines whether a this portlet is
currently in a minimized state.
Returns
- A value of primitive type
boolean
that determines
whether this portlet is currently minimized.
isRemovable() Method
public boolean isRemovable()
Method isRemovable
determines whether this portlet
currently has the 'removable' attribute set for this user.
Returns
- A value of type
boolean
representing whether
this portlet has the 'removable' attribute set for this user.