Overview | Package | Class | Tree | Deprecated | Index | Help
| © 2003 BEA Systems, Inc.
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## com.bea.portal.model
Interface Portlet

All Superinterfaces:
  PortalResource, PortalScopedObject

public interface Portlet
extends PortalResource

Interface `Portlet` represents the definition of a portlet as defined in the E-Business Control Center (EBCC).

Field Summary
`static int` | `URL_ALTERNATE_FOOTER` Constant to represent a URL of type Alternate Footer.
`static int` | `URL_ALTERNATE_HEADER` Constant to represent a URL of type Alternate Header.
`static int` | `URL_BANNER` Constant to represent a URL of type Banner.
`static int` | `URL_CONTENT` Constant to represent a URL of type Content.
`static int` | `URL_EDIT` Constant to represent a URL of type Edit.
`static int` | `URL_FOOTER` Constant to represent a URL of type Footer.
`static int` | `URL_HEADER` Constant to represent a URL of type Header.
`static int` | `URL_HELP` Constant to represent a URL of type Help.
`static int` | `URL_ICON` Constant to represent a URL of type Icon.
`static int` | `URL_MAXIMIZE` Constant to represent a URL of type Maximize.
`static int` | `URL_TITLEBAR` Constant to represent a URL of type Titlebar.

Method Summary
`PortletIdentifier` | `getIdentifier()` Returns the unique identifier for this portlet.
`String` | `getUrl(int urlType)` Returns a `String` URL for the URL type specified.
`String` | `getWebflowNamespace()` Returns the Webflow namespace to use for the portlet navigation.
`Boolean` | `isAvailable()` Determines whether this portlet was initially defined as Available in the EBCC.
`Boolean` | `isDefaultStateMinimized()` Determines whether this portlet was initially defined as having a default state of Minimized in the EBCC.
`Boolean` | `isEditable()` Determines whether this portlet was initially defined as Editable in the EBCC.
`Boolean` | `isFloatable()` Determines whether this portlet was initially defined as Floatable in the EBCC.
`Boolean` | `isHelpable()` Determines whether this portlet was initially defined as Helpable in the EBCC.
`Boolean` | `isLoginRequired()` Determines whether this portlet was defined as Login Required in the EBCC.
`Boolean` | `isMandatory()` Determines whether this portlet was initially defined as Mandatory in the EBCC.
`Boolean` | `isMaximizable()` Determines whether this portlet was initially defined as Maximizable in the EBCC.
`Boolean` | `isMinimizable()` Determines whether this portlet was initially defined as Minimizable in the EBCC.
`Boolean` | `isMovable()` Determines whether this portlet was initially defined as Moveable in the EBCC.
`Boolean` | `isVisible()` Determines whether this portlet was initially defined as Visible in the EBCC.

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

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

Field Detail

### URL_CONTENT

    public static final int URL_CONTENT

  Constant to represent a URL of type Content.

  See Also:
    Constant Field Values

### URL_HEADER

    public static final int URL_HEADER

  Constant to represent a URL of type Header.

  See Also:
    Constant Field Values

### URL_FOOTER

    public static final int URL_FOOTER

  Constant to represent a URL of type Footer.

  See Also:
    Constant Field Values

### URL_ALTERNATE_HEADER

    public static final int URL_ALTERNATE_HEADER

  Constant to represent a URL of type Alternate Header.

  See Also:
    Constant Field Values

### URL_ALTERNATE_FOOTER

    public static final int URL_ALTERNATE_FOOTER

  Constant to represent a URL of type Alternate Footer.

  See Also:
    Constant Field Values

### URL_TITLEBAR

    public static final int URL_TITLEBAR

  Constant to represent a URL of type Titlebar.

  See Also:
    Constant Field Values

### URL_BANNER

    public static final int URL_BANNER

  Constant to represent a URL of type Banner.

  See Also:
    Constant Field Values

### URL_EDIT

    public static final int URL_EDIT

  Constant to represent a URL of type Edit.

  See Also:
    Constant Field Values

### URL_HELP

    public static final int URL_HELP

  Constant to represent a URL of type Help.

  See Also:
    Constant Field Values

### URL_ICON

    public static final int URL_ICON

  Constant to represent a URL of type Icon.

  See Also:
    Constant Field Values

### URL_MAXIMIZE

    public static final int URL_MAXIMIZE

  Constant to represent a URL of type Maximize.

  See Also:
    Constant Field Values

Method Detail

### getIdentifier

    public PortletIdentifier getIdentifier()

  Returns the unique identifier for this portlet.

  Returns:
    `PortletIdentifier` for this portlet.

### getUrl

    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

    public String getWebflowNamespace()

  Returns the Webflow namespace to use for the portlet navigation.

  Returns:
    a Webflow namespace for portlet navigation.

### isEditable

    public Boolean isEditable()

  Determines whether this portlet was initially defined as Editable in the EBCC.

  Returns:
    whether the portlet was initially specified as Editable.

### isAvailable

    public Boolean isAvailable()

  Determines whether this portlet was initially defined as Available in the EBCC.

  Returns:
    whether the portlet was initially specified as Available.

### isMandatory

    public Boolean isMandatory()

  Determines whether this portlet was initially defined as Mandatory in the EBCC.

  Returns:
    whether the portlet was initially specified as Mandatory.

### isMovable

    public Boolean isMovable()

  Determines whether this portlet was initially defined as Moveable in the EBCC.

  Returns:
    whether the portlet was initially specified as Moveable.

### isMinimizable

    public Boolean isMinimizable()

  Determines whether this portlet was initially defined as Minimizable in the EBCC.

  Returns:
    whether the portlet was initially specified as Minimizable.

### isMaximizable

    public Boolean isMaximizable()

  Determines whether this portlet was initially defined as Maximizable in the EBCC.

  Returns:
    whether the portlet was initially specified as Maximizable.

### isFloatable

    public Boolean isFloatable()

  Determines whether this portlet was initially defined as Floatable in the EBCC.

  Returns:
    whether the portlet was initially specified as Floatable.

### isVisible

    public Boolean isVisible()

  Determines whether this portlet was initially defined as Visible in the EBCC.

  Returns:
    whether the portlet was initially specified as Visible.

### isDefaultStateMinimized

    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.

### isLoginRequired

    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.

### isHelpable

    public Boolean isHelpable()

  Determines whether this portlet was initially defined as Helpable in the EBCC.

  Returns:
    whether the portlet was initially specified as Helpable.

Overview | Package | Class | Tree | Deprecated | Index | Help
| © 2003 BEA Systems, Inc.
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Copyright © 2003 BEA Systems, Inc. All Rights Reserved