Portlet 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
Portlet Interface

public interface Portlet

    extends com.bea.portal.model.PortalResource

Interface Portlet represents the definition of a portlet 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 int
URL_ALTERNATE_FOOTER
Constant to represent a URL of type Alternate Footer.
public static final int
URL_ALTERNATE_HEADER
Constant to represent a URL of type Alternate Header.
public static final int
URL_BANNER
Constant to represent a URL of type Banner.
public static final int
URL_CONTENT
Constant to represent a URL of type Content.
public static final int
URL_EDIT
Constant to represent a URL of type Edit.
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_HELP
Constant to represent a URL of type Help.
public static final int
URL_ICON
Constant to represent a URL of type Icon.
public static final int
URL_MAXIMIZE
Constant to represent a URL of type Maximize.
public static final int
URL_TITLEBAR
Constant to represent a URL of type Titlebar.
 

Method Summary

public PortletIdentifier
getIdentifier()
Returns the unique identifier for this portlet.
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 portlet navigation.
public Boolean
isAvailable()
Determines whether this portlet was initially defined as Available in the EBCC.
public Boolean
isDefaultStateMinimized()
Determines whether this portlet was initially defined as having a default state of Minimized in the EBCC.
public Boolean
isEditable()
Determines whether this portlet was initially defined as Editable in the EBCC.
public Boolean
isFloatable()
Determines whether this portlet was initially defined as Floatable in the EBCC.
public Boolean
isHelpable()
Determines whether this portlet was initially defined as Helpable in the EBCC.
public Boolean
isLoginRequired()
Determines whether this portlet was defined as Login Required in the EBCC.
public Boolean
isMandatory()
Determines whether this portlet was initially defined as Mandatory in the EBCC.
public Boolean
isMaximizable()
Determines whether this portlet was initially defined as Maximizable in the EBCC.
public Boolean
isMinimizable()
Determines whether this portlet was initially defined as Minimizable in the EBCC.
public Boolean
isMovable()
Determines whether this portlet was initially defined as Moveable in the EBCC.
public Boolean
isVisible()
Determines whether this portlet was initially defined as Visible in the EBCC.
 
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

URL_ALTERNATE_FOOTER

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


URL_ALTERNATE_HEADER

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


URL_BANNER

public static final int URL_BANNER
Constant to represent a URL of type Banner.


URL_CONTENT

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


URL_EDIT

public static final int URL_EDIT
Constant to represent a URL of type Edit.


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_HELP

public static final int URL_HELP
Constant to represent a URL of type Help.


URL_ICON

public static final int URL_ICON
Constant to represent a URL of type Icon.


URL_MAXIMIZE

public static final int URL_MAXIMIZE
Constant to represent a URL of type Maximize.


URL_TITLEBAR

public static final int URL_TITLEBAR
Constant to represent a URL of type Titlebar.

 

Method Detail

getIdentifier() Method

public PortletIdentifier getIdentifier()
Returns the unique identifier for this portlet.

Returns

PortletIdentifier for this portlet.

getUrl(int) Method

public String getUrl(int urlType)
Returns a String URL for the URL type specified. Valid values are:

Portlet.URL_CONTENT Portlet.URL_HEADER Portlet.URL_FOOTER Portlet.URL_ALTERNATE_HEADER Portlet.URL_ALTERNATE_FOOTER Portlet.URL_TITLEBAR Portlet.URL_BANNER Portlet.URL_EDIT Portlet.URL_HELP Portlet.URL_ICON Portlet.URL_MAXIMIZE

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

Returns

a Webflow namespace for portlet navigation.

isAvailable() Method

public Boolean isAvailable()
Determines whether this portlet was initially defined as Available in the EBCC.

Returns

whether the portlet was initially specified as Available.

isDefaultStateMinimized() Method

public Boolean isDefaultStateMinimized()
Determines whether this portlet was initially defined as having a default state of Minimized in the EBCC.

Returns

whether the portlet was specified as default Minimized.

isEditable() Method

public Boolean isEditable()
Determines whether this portlet was initially defined as Editable in the EBCC.

Returns

whether the portlet was initially specified as Editable.

isFloatable() Method

public Boolean isFloatable()
Determines whether this portlet was initially defined as Floatable in the EBCC.

Returns

whether the portlet was initially specified as Floatable.

isHelpable() Method

public Boolean isHelpable()
Determines whether this portlet was initially defined as Helpable in the EBCC.

Returns

whether the portlet was initially specified as Helpable.

isLoginRequired() Method

public Boolean isLoginRequired()
Determines whether this portlet was defined as Login Required in the EBCC.

Returns

whether the portlet was initially specified as Login Required.

isMandatory() Method

public Boolean isMandatory()
Determines whether this portlet was initially defined as Mandatory in the EBCC.

Returns

whether the portlet was initially specified as Mandatory.

isMaximizable() Method

public Boolean isMaximizable()
Determines whether this portlet was initially defined as Maximizable in the EBCC.

Returns

whether the portlet was initially specified as Maximizable.

isMinimizable() Method

public Boolean isMinimizable()
Determines whether this portlet was initially defined as Minimizable in the EBCC.

Returns

whether the portlet was initially specified as Minimizable.

isMovable() Method

public Boolean isMovable()
Determines whether this portlet was initially defined as Moveable in the EBCC.

Returns

whether the portlet was initially specified as Moveable.

isVisible() Method

public Boolean isVisible()
Determines whether this portlet was initially defined as Visible in the EBCC.

Returns

whether the portlet was initially specified as Visible.