Portal 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

com.bea.portal.model
Portal Interface

public interface Portal

    extends com.bea.portal.model.PortalResource

Interface Portal represents the definition of a portal as defined in the E-Business Control Center (EBCC).

All Superinterfaces
com.bea.portal.model.PortalResource, com.bea.portal.model.PortalScopedObject

Field Summary
public static final String
DEFAULT_GROUP_PORTAL_DISPLAY_NAME_UNCUSTOMIZED
Constant to represent the uncustomized display name of the default group portal.
public static final int
NAVBAR_ORIENTATION_HORIZONTAL
Constant to represent a navigation bar with horizontal orientation.
public static final int
NAVBAR_ORIENTATION_UNSPECIFIED
Constant to represent a navigation bar with unspecified orientation.
public static final int
NAVBAR_ORIENTATION_VERTICAL
Constant to represent a navigation bar with vertical orientation.
public static final int
URL_CONTENT
Constant to represent a URL of type Content.
public static final int
URL_FOOTER
Constant to represent a URL of type Footer.
public static final int
URL_HEADER
Constant to represent a URL of type Header.
public static final int
URL_NAVBAR_HORIZONTAL
Constant to represent a URL of Horizontal Navigation Bar.
public static final int
URL_NAVBAR_VERTICAL
Constant to represent a URL of Vertical Navigation Bar.
public static final int
URL_START_PAGE
Constant to represent a URL of Start Page.
public static final int
URL_SUSPENDED
Constant to represent a URL of type Suspended.
 

Method Summary
public PortalPersonalization
getDefaultConfiguration()
Returns a PortalPersonalization representing the default personalization for this portal.
public String
getDescription()
Returns a short text description of this portal.
public PortalIdentifier
getIdentifier()
Returns a unique identifier for this portal.
public List
getLayouts()
Returns a List of LayoutIdentifier objects for the layouts available for selection in this portal.
public Page
getPage(PageIdentifier pageId)
Returns the Page requested by identifier.
public List
getPages()
Returns a List of Page objects for the pages available in this portal.
public Portlet
getPortlet(PortletIdentifier portletId)
Returns the Portlet requested by identifier.
public List
getPortlets()
Returns a List of Portlet objects for the portlets available in this portal.
public List
getPropertySets()
Returns a List of String objects specifying the property sets to be made available to this portal.
public List
getSkins()
Returns a List of SkinIdentifier objects for the skins available for selection in this portal.
public String
getUrl(int urlType)
Returns a String URL for the URL type specified.
public String
getWebflowNamespace()
Returns the Webflow namespace to use for the portal navigation.
 
Methods from interface com.bea.portal.model.com.bea.portal.model.PortalResource
getResourceIdentifier
 
Methods from interface com.bea.portal.model.com.bea.portal.model.PortalScopedObject
getPortalIdentifier
   

Field Detail

DEFAULT_GROUP_PORTAL_DISPLAY_NAME_UNCUSTOMIZED

public static final String DEFAULT_GROUP_PORTAL_DISPLAY_NAME_UNCUSTOMIZED
Constant to represent the uncustomized display name of the default group portal.

NAVBAR_ORIENTATION_HORIZONTAL

public static final int NAVBAR_ORIENTATION_HORIZONTAL
Constant to represent a navigation bar with horizontal orientation.

NAVBAR_ORIENTATION_UNSPECIFIED

public static final int NAVBAR_ORIENTATION_UNSPECIFIED
Constant to represent a navigation bar with unspecified orientation.

NAVBAR_ORIENTATION_VERTICAL

public static final int NAVBAR_ORIENTATION_VERTICAL
Constant to represent a navigation bar with vertical orientation.

URL_CONTENT

public static final int URL_CONTENT
Constant to represent a URL of type Content.

URL_FOOTER

public static final int URL_FOOTER
Constant to represent a URL of type Footer.

URL_HEADER

public static final int URL_HEADER
Constant to represent a URL of type Header.

URL_NAVBAR_HORIZONTAL

public static final int URL_NAVBAR_HORIZONTAL
Constant to represent a URL of Horizontal Navigation Bar.

URL_NAVBAR_VERTICAL

public static final int URL_NAVBAR_VERTICAL
Constant to represent a URL of Vertical Navigation Bar.

URL_START_PAGE

public static final int URL_START_PAGE
Constant to represent a URL of Start Page.

URL_SUSPENDED

public static final int URL_SUSPENDED
Constant to represent a URL of type Suspended.

 

Method Detail

getDefaultConfiguration() Method

public PortalPersonalization getDefaultConfiguration()
Returns a PortalPersonalization representing the default personalization for this portal.

Returns

personalization of default group.

getDescription() Method

public String getDescription()
Returns a short text description of this portal.

Returns

a description of this portal.

getIdentifier() Method

public PortalIdentifier getIdentifier()
Returns a unique identifier for this portal.

Returns

unique identifier for this portal.

getLayouts() Method

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

getPage(PageIdentifier) Method

public Page getPage(PageIdentifier pageId)
Returns the Page requested by identifier.

Parameters

pageId
identifier for page required.

Returns

the page definition requested.

getPages() Method

public List getPages()
Returns a List of Page objects for the pages available in this portal.

Note: This is the set of pages 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 page available in this portal.

getPortlet(PortletIdentifier) Method

public Portlet getPortlet(PortletIdentifier portletId)
Returns the Portlet requested by identifier.

Parameters

portletId
identifier for portlet required.

Returns

the portlet definition requested.

getPortlets() Method

public List 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()
Returns a List of String objects specifying the property sets to be made available to this portal.

Returns

property set names for this portal.

getSkins() Method

public List 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)
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()
Returns the Webflow namespace to use for the portal navigation.

Returns

a Webflow namespace for portal navigation.