PortalState 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 PortalState
Interface PortalState
represents the dynamic view of a portal
by a portal user. After all appropriate personalizations, attributes and
entitlements have been considered for the portal view then a
PortalState
will be generated.
public PageState |
-
getCurrentPageState ()
- Method
getCurrentPageState returns the
PageState for the current page.
|
public String |
-
getDescription ()
- Method
getDescription retrieves the description of this
portal as defined by the EBCC.
|
public String |
-
getDisplayName ()
- Method
getDisplayName retrieves the personalized display
name of the associated portal.
|
public List |
-
getLayouts ()
- Method
getLayouts returns a List of
LayoutIdentifier objects for the layouts available for
selection in this portal.
|
public int |
-
getNavBarOrientation ()
- Method
getNavBarOrientation retrieves the currently
selected navigation bar orientation for the associated user.
|
public PageState |
-
getPageState (PageIdentifier pageId)
- Method
getPageState retrieves the state of the page
specified for the current user.
|
public Iterator |
-
getPageStates ()
- Method
getPageStates retrieves the state of all
pages which are visible to the current user.
|
public PortalIdentifier |
-
getPortalIdentifier ()
- Method
getPortalIdentifier retrieves the identifier of
the portal that this object is the state of.
|
public Portlet |
-
getPortlet (PortletIdentifier portletId)
- Method
getPortlet returns the Portlet
requested by identifier.
|
public List |
-
getPortlets ()
- Method
getPortlets returns a List of
Portlet objects for the portlets available in this portal.
|
public List |
-
getPropertySets ()
- Method
getPropertySets returns a List of
String objects specifying the property sets to be made
available to this portal.
|
public SkinDefinition |
-
getSelectedSkin ()
- Method
getSelectedSkin returns the selected skin for this
user.
|
public SkinIdentifier |
-
getSkin ()
- Method
getSkin retrieves the currently selected
skin for the associated user.
|
public SkinDefinition |
-
getSkin (SkinIdentifier skinId)
- Method
getSkin returns the SkinDefinition
requested by identifier.
|
public List |
-
getSkins ()
- Method
getSkins returns a List of
SkinIdentifier objects for the skins available for
selection in this portal.
|
public String |
-
getUrl (int urlType)
- Method
getUrl returns a String URL for the URL
type specified.
|
public String |
-
getWebflowNamespace ()
- Method
getWebflowNamespace returns the Webflow namespace
to use for the portal navigation.
|
getCurrentPageState() Method
public PageState
getCurrentPageState()
Method getCurrentPageState
returns the
PageState
for the current page.
Returns
- page state for current page.
getDescription() Method
public String
getDescription()
Method getDescription
retrieves the description of this
portal as defined by the EBCC.
Returns
- A value of type
String
used to describe the portal.
getDisplayName() Method
public String
getDisplayName()
Method getDisplayName
retrieves the personalized display
name of the associated portal. This data is personalized to the
associated user at group scope.
Returns
- A value of type
String
used to describe the portal to
the associated user.
getLayouts() Method
public List
getLayouts()
Method getLayouts
returns a List
of
LayoutIdentifier
objects for the layouts available for
selection in this portal.
Note: This is the union of all the sets of layouts available
on each page and not necessarily the list an end user will see.
Returns
- the set of layouts available in this portal.
getNavBarOrientation() Method
public int getNavBarOrientation()
Method getNavBarOrientation
retrieves the currently
selected navigation bar orientation for the associated user. This
data is personalized to the associated user at user scope.
Returns
- A value of type
int
used to specify the currently
selected navigation bar orientation for the associated user.
Allowed values:
Portal.NAVBAR_ORIENTATION_UNSPECIFIED,
Portal.NAVBAR_ORIENTATION_VERTICAL,
Portal.NAVBAR_ORIENTATION_HORIZONTAL.
getPageState(PageIdentifier) Method
public PageState
getPageState(PageIdentifier
pageId)
Method getPageState
retrieves the state of the page
specified for the current user.
Parameters
-
pageId
- A parameter of type
PageIdentifier
used to specify
the page for which state is required.
Returns
- A value of type
PageState
representing the state
of the page specified.
getPageStates() Method
public Iterator
getPageStates()
Method getPageStates
retrieves the state of all
pages which are visible to the current user.
Returns
- An
Iterator
over a set of objects of type
PageState
representing the state of all visible
page.
getPortalIdentifier() Method
public PortalIdentifier
getPortalIdentifier()
Method getPortalIdentifier
retrieves the identifier of
the portal that this object is the state of.
Returns
- A value of type
PortalIdentifier
used to specify the
portal that this object is the state of.
getPortlet(PortletIdentifier) Method
public Portlet
getPortlet(PortletIdentifier
portletId)
Method getPortlet
returns the Portlet
requested by identifier.
Parameters
-
portletId
- identifier for portlet required.
Returns
- the portlet definition requested.
getPortlets() Method
public List
getPortlets()
Method getPortlets
returns a List
of
Portlet
objects for the portlets available in this portal.
Note: This is the set of portlets available for group administrators
to select from, as defined in the EBCC and not necessarily the list an
end user will see.
Returns
- the set of portlets available in this portal.
getPropertySets() Method
public List
getPropertySets()
Method getPropertySets
returns a List
of
String
objects specifying the property sets to be made
available to this portal.
Returns
- property set names for this portal.
getSelectedSkin() Method
public SkinDefinition
getSelectedSkin()
Method getSelectedSkin
returns the selected skin for this
user.
Returns
- the selected skin for this user.
getSkin() Method
public SkinIdentifier
getSkin()
Method getSkin
retrieves the currently selected
skin for the associated user. This data is personalized to the associated
user at user scope.
Returns
- A value of type
SkinIdentifier
used to specify the
currently selected skin for the associated user.
getSkin(SkinIdentifier) Method
public SkinDefinition
getSkin(SkinIdentifier
skinId)
Method getSkin
returns the SkinDefinition
requested by identifier.
Parameters
-
skinId
- identifier for skin required.
Returns
- the skin definition requested.
getSkins() Method
public List
getSkins()
Method getSkins
returns a List
of
SkinIdentifier
objects for the skins available for
selection in this portal.
Note: This is the set of skins available for group administrators
to select from, as defined in the EBCC, and not necessarily the list an
end user will see.
Returns
- the set of skins available in this portal.
getUrl(int) Method
public String
getUrl(int urlType)
Method getUrl
returns a String
URL for the URL
type specified. Valid values are:
Portal.URL_CONTENT
Portal.URL_HEADER
Portal.URL_FOOTER
Portal.URL_SUSPENDED
Portal.URL_NAVBAR_VERTICAL
Portal.URL_NAVBAR_HORIZONTAL
Portal.URL_START_PAGE
Parameters
-
urlType
- a constant specifying the URL type required.
Returns
- the URL defined for the type specified.
getWebflowNamespace() Method
public String
getWebflowNamespace()
Method getWebflowNamespace
returns the Webflow namespace
to use for the portal navigation.
Returns
- a Webflow namespace for portal navigation.