org.gatein.pc.api.info

Interface CapabilitiesInfo

public interface CapabilitiesInfo

Gathers capability information (portlet modes, window states, supported media types and locales) regarding a portlet.

Since:

2.4

Version:

$Revision: 5448 $

Author:

Julien Viet

Method Summary

Modifier and Type	Method and Description
Set<Locale>	getAllLocales() Retrieves all the locales supported by the associated Portlet.
Set<ModeInfo>	getAllModes() Retrieves all the portlet modes supported by the associated Portlet.
Set<WindowStateInfo>	getAllWindowStates() Retrieves all the window states supported by the associated Portlet.
Set<Locale>	getLocales(org.gatein.common.net.media.MediaType mimeType) Retrieves the locales supported by the associated Portlet for the specified MIME type.
Set<org.gatein.common.net.media.MediaType>	getMediaTypes() Retrieves all the Media types supported by the associated Portlet.
ModeInfo	getMode(Mode mode) Returns a mode info matching a specifed mode or null.
Set<ModeInfo>	getModes(org.gatein.common.net.media.MediaType mediaType) Retrieves the portlet modes supported by the associated Portlet for the specified Media type.
WindowStateInfo	getWindowState(WindowState windowState) Returns a window state info matching a specifed window state or null.
Set<WindowStateInfo>	getWindowStates(org.gatein.common.net.media.MediaType mimeType) Retrieves the window states supported by the associated Portlet for the specified MIME type.

Method Detail

getMediaTypes

Set<org.gatein.common.net.media.MediaType> getMediaTypes()

Retrieves all the Media types supported by the associated Portlet.

Returns:

a Set of String representation of supported Media types

getAllModes

Set<ModeInfo> getAllModes()

Retrieves all the portlet modes supported by the associated Portlet.

Returns:

a Set of ModeInfo reprensenting the supported portlet modes

getModes

Set<ModeInfo> getModes(org.gatein.common.net.media.MediaType mediaType)

Retrieves the portlet modes supported by the associated Portlet for the specified Media type.

Parameters:

mediaType - the media type

Returns:

a Set of ModeInfo reprensenting the supported portlet modes for the specified Media type

getMode

ModeInfo getMode(Mode mode)

Returns a mode info matching a specifed mode or null.

Parameters:

mode - the mode

Returns:

the mode info

getAllWindowStates

Set<WindowStateInfo> getAllWindowStates()

Retrieves all the window states supported by the associated Portlet.

Returns:

a Set of WindowStateInfo reprensenting the supported window states

getWindowStates

Set<WindowStateInfo> getWindowStates(org.gatein.common.net.media.MediaType mimeType)

Retrieves the window states supported by the associated Portlet for the specified MIME type.

Parameters:

mimeType - the mime type

Returns:

a Set of ModeInfo reprensenting the supported window states for the specified MIME type

getWindowState

WindowStateInfo getWindowState(WindowState windowState)

Returns a window state info matching a specifed window state or null.

Parameters:

windowState - the window state

Returns:

the window state info

getAllLocales

Set<Locale> getAllLocales()

Retrieves all the locales supported by the associated Portlet.

Returns:

the Set of supported Locales

getLocales

Set<Locale> getLocales(org.gatein.common.net.media.MediaType mimeType)

Retrieves the locales supported by the associated Portlet for the specified MIME type.

Parameters:

mimeType - the mime type

Returns:

a Set of supported Locales for the specified MIME type