com.bea.portal.model
Interface UserPortletState

All Superinterfaces:

PortalResource, PortalScopedObject

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

Method Summary

String	getDisplayName() Deprecated. Method getDisplayName returns the display name of this portlet.
PlaceholderIdentifier	getPlaceholderIdentifier() Deprecated. Method getPlaceholderIdentifier retrieves an identifier for the placeholder that this portlet instance is currently situated within.
int	getPlaceholderIndex() Deprecated. Method getPlaceholderIndex retrieves an index representing an ordering for this portlet within the placeholder that is specified by the getPlaceholderIdentifier method.
PortletIdentifier	getPortletIdentifier() Deprecated. Method getPortletIdentifier retrieves an identifier representing the portlet definition that this portlet is an instance of.
boolean	isEditable() Deprecated. Method isEditable determines whether this portlet currently has the 'editable' attribute set for this user.
boolean	isFloatable() Deprecated. Method isFloatable determines whether this portlet currently has the 'floatable' attribute set for this user.
boolean	isHelpable() Deprecated. Method isHelpable determines whether this portlet currently has the 'helpable' attribute set for this user.
boolean	isMaximizable() Deprecated. Method isMaximizable determines whether this portlet currently has the 'maximizable' attribute set for this user.
boolean	isMinimizable() Deprecated. Method isMinimizable determines whether this portlet currently has the 'minimizable' attribute set for this user.
boolean	isMinimized() Deprecated. Method isMinimized determines whether a this portlet is currently in a minimized state.
boolean	isRemovable() Deprecated. Method isRemovable determines whether this portlet currently has the 'removable' attribute set for this user.

Methods inherited from interface com.bea.portal.model.PortalResource

getResourceIdentifier

Methods inherited from interface com.bea.portal.model.PortalScopedObject

getPortalIdentifier

Method Detail

getDisplayName

public String getDisplayName()

Deprecated.

Method getDisplayName returns the display name of this portlet.

Returns:

A value of type String representing the name of this portlet.

getPlaceholderIdentifier

public PlaceholderIdentifier getPlaceholderIdentifier()

Deprecated.

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

public int getPlaceholderIndex()

Deprecated.

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

public PortletIdentifier getPortletIdentifier()

Deprecated.

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

public boolean isEditable()

Deprecated.

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

public boolean isFloatable()

Deprecated.

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

public boolean isHelpable()

Deprecated.

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

public boolean isMaximizable()

Deprecated.

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

public boolean isMinimizable()

Deprecated.

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

public boolean isMinimized()

Deprecated.

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

public boolean isRemovable()

Deprecated.

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.