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.PortalResource
Interface UserPageState
represents the current state of a portal
page with respect to a specific user session. All the data required to
personalize the associated portal page should be available through this
interface.
com.bea.portal.model.PortalResource
, com.bea.portal.model.PortalScopedObject
Method Summary |
public |
|
public |
|
public |
|
public |
|
public |
|
public |
|
Methods from interface com.bea.portal.model. |
|
Methods from interface com.bea.portal.model. |
|
Method Detail |
public LayoutIdentifier
getLayoutIdentifier()
Method getLayoutIdentifier
retrieves an identifier for the
layout specified to be used to render this portal page. This identifier
simply contains a String which maps to a subdirectory under the defined
layout directory. All the extra resources required to render the layout
template should be loaded from this directory. This data is associated to
the user at user scope.
LayoutIdentifier
used to specify the
layout template to use to render this portal page.
public UserPageStateMetadata
getMetadata()
Method getMetadata
retrieves the metadata object
associated with this user page state.
UserPageStateMetadata
used to specify the
information such as the display name and index of the page.
public PageIdentifier
getPageIdentifier()
Method getPageIdentifier
retrieves the identifier of
the portal page that this object is the state of.
PageIdentifier
used to specify the
portal page that this object is the state of. publicMethodList
getPortletsForPlaceholder(String
placeholderId)
getPortletsForPlaceholder
retrieves the list of all
PortletIdentifier
objects that are associated with visible
portlets situated within the supplied placeholder.
String used to specify the
placeholder for which we should return portlet states.
List
containing the portlet states
associated with visible portlets in the supplied placeholder. publicMethodUserPortletState
getUserPortletState(PortletIdentifier
portletId)
getUserPortletState
retrieves an object representing
the state of the specified portlet personalized for the associated user.
NOTE: the definition of UserPortalState
requires that only
UserPortletState
objects associated with visible portlets
on the current page be maintained in the PortalState
.
PortletIdentifier used to specify
the portlet type for which state is required.
UserPortletState
used to specify the state
of the specified portlet for the associated user.
public HashMap
getUserPortletStates()
Method getAllUserPortletState
retrieves the list of all
UserPortletState
objects within this UserPageState
NOTE: the definition of UserPortalState
requires that only
USerPortletState
objects associated with visible portlets
on the current page be maintained in the UserPortalState
.
UserPortletState
used to specify the state
of the specified portlet for the associated user.