org.exoplatform.services.portletcontainer.pci.model
Class Portlet

java.lang.Object
  org.exoplatform.services.portletcontainer.pci.model.Portlet

public class Portlet
extends Object

Jul 11, 2004 .

Constructor Summary

Portlet()

Method Summary

void	addContainerRuntimeOption(Map<String,String[]> containerRuntimeOption1)
void	addContainerRuntimeOption(String name, String[] value)
void	addDescription(Description desc)
void	addDisplayName(DisplayName name)
void	addInitParam(InitParam param)
void	addSecurityRoleRef(SecurityRoleRef ref)
void	addSharedSessionAttribute(SharedSessionAttribute ssa)
void	addSupportedLocale(Locale value)
void	addSupportedProcessingEvent(QName spe)
void	addSupportedPublicRenderParameter(String srp)
void	addSupportedPublishingEvent(QName spe)
void	addSupports(Supports s)
PortletApp	getApplication()
Integer	getCaching()
Map<String,String[]>	getContainerRuntimeOption()
List<Description>	getDescription()
String	getDescription(String lang)
List<DisplayName>	getDisplayName()
Boolean	getEscapeXml()
javax.portlet.filter.FilterChain	getFilterChain()
String	getGlobalCache()
String	getId()
List<InitParam>	getInitParam()
String	getPortletClass()
PortletInfo	getPortletInfo()
String	getPortletName()
ExoPortletPreferences	getPortletPreferences()
int	getPortletSessionScope()
String	getResourceBundle()
List<SecurityRoleRef>	getSecurityRoleRef()
List<SharedSessionAttribute>	getSharedSessionAttribute()
List<Locale>	getSupportedLocale()
List<QName>	getSupportedProcessingEvent()
List<String>	getSupportedPublicRenderParameter()
List<QName>	getSupportedPublishingEvent()
List<Supports>	getSupports()
void	setApplication(PortletApp app)
void	setCaching(Integer caching)
void	setContainerRuntimeOption(Map<String,String[]> containerRuntimeOption)
void	setDescription(List<Description> description)
void	setDisplayName(List<DisplayName> displayName)
void	setEscapeXml(boolean escapeXml)
void	setEscapeXml(Boolean escapeXml)
void	setFilterChain(javax.portlet.filter.FilterChain filterChain)
void	setGlobalCache(String globalCache)
void	setId(String id)
void	setInitParam(List<InitParam> initParam)
void	setPortletClass(String portletClass)
void	setPortletInfo(PortletInfo portletInfo)
void	setPortletName(String portletName)
void	setPortletPreferences(ExoPortletPreferences portletPreferences)
void	setResourceBundle(String resourceBundle)
void	setSecurityRoleRef(List<SecurityRoleRef> securityRoleRef)
void	setSupportedLocale(List<Locale> supportedLocale)
void	setSupportedProcessingEvent(List<QName> list)
void	setSupportedPublishingEvent(List<QName> list)
void	setSupports(Supports s)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Portlet

public Portlet()

Method Detail

getApplication

public final PortletApp getApplication()

Returns:

portlet app object

setApplication

public final void setApplication(PortletApp app)

Parameters:

app - portlet app object

setEscapeXml

public final void setEscapeXml(Boolean escapeXml)

Parameters:

escapeXml - either escape XML

setEscapeXml

public final void setEscapeXml(boolean escapeXml)

Parameters:

escapeXml - either escape XML

getEscapeXml

public final Boolean getEscapeXml()

Returns:

either escape XML

getPortletSessionScope

public final int getPortletSessionScope()

Returns:

portlet session scope

getFilterChain

public final javax.portlet.filter.FilterChain getFilterChain()

Returns:

filter chain

setFilterChain

public final void setFilterChain(javax.portlet.filter.FilterChain filterChain)

Parameters:

filterChain - filter chain

getDescription

public final List<Description> getDescription()

Returns:

description list

getDescription

public final String getDescription(String lang)

Parameters:

lang - language

Returns:

description

setDescription

public final void setDescription(List<Description> description)

Parameters:

description - description list

addDescription

public final void addDescription(Description desc)

Parameters:

desc - description

getDisplayName

public final List<DisplayName> getDisplayName()

Returns:

display name list

addDisplayName

public final void addDisplayName(DisplayName name)

Parameters:

name - display name

setDisplayName

public final void setDisplayName(List<DisplayName> displayName)

Parameters:

displayName - display name list

getCaching

public final Integer getCaching()

Returns:

caching value

setCaching

public final void setCaching(Integer caching)

Parameters:

caching - caching value

getGlobalCache

public final String getGlobalCache()

Returns:

global cache

setGlobalCache

public final void setGlobalCache(String globalCache)

Parameters:

globalCache - global cache

getId

public final String getId()

Returns:

id

setId

public final void setId(String id)

Parameters:

id - id

getInitParam

public final List<InitParam> getInitParam()

Returns:

init param list

setInitParam

public final void setInitParam(List<InitParam> initParam)

Parameters:

initParam - init param list

addInitParam

public final void addInitParam(InitParam param)

Parameters:

param - init param

getPortletClass

public final String getPortletClass()

Returns:

class FQN

setPortletClass

public final void setPortletClass(String portletClass)

Parameters:

portletClass - class FQN

getPortletInfo

public final PortletInfo getPortletInfo()

Returns:

info

setPortletInfo

public final void setPortletInfo(PortletInfo portletInfo)

Parameters:

portletInfo - info

getPortletName

public final String getPortletName()

Returns:

name

setPortletName

public final void setPortletName(String portletName)

Parameters:

portletName - name

getPortletPreferences

public final ExoPortletPreferences getPortletPreferences()

Returns:

prefs

setPortletPreferences

public final void setPortletPreferences(ExoPortletPreferences portletPreferences)

Parameters:

portletPreferences - prefs

getResourceBundle

public final String getResourceBundle()

Returns:

name

setResourceBundle

public final void setResourceBundle(String resourceBundle)

Parameters:

resourceBundle - name

getSecurityRoleRef

public final List<SecurityRoleRef> getSecurityRoleRef()

Returns:

SecurityRoleRef object list

setSecurityRoleRef

public final void setSecurityRoleRef(List<SecurityRoleRef> securityRoleRef)

Parameters:

securityRoleRef - SecurityRoleRef object list

addSecurityRoleRef

public final void addSecurityRoleRef(SecurityRoleRef ref)

Parameters:

ref - SecurityRoleRef object

getSupportedLocale

public final List<Locale> getSupportedLocale()

Returns:

locale list

setSupportedLocale

public final void setSupportedLocale(List<Locale> supportedLocale)

Parameters:

supportedLocale - locale list

addSupportedLocale

public final void addSupportedLocale(Locale value)

Parameters:

value - locale

getSupports

public final List<Supports> getSupports()

Returns:

Supports object list

setSupports

public final void setSupports(Supports s)

Parameters:

s - Supports object

addSupports

public final void addSupports(Supports s)

Parameters:

s - Supports object

getSharedSessionAttribute

public final List<SharedSessionAttribute> getSharedSessionAttribute()

Returns:

attribute list

addSharedSessionAttribute

public final void addSharedSessionAttribute(SharedSessionAttribute ssa)

Parameters:

ssa - attribute

getSupportedProcessingEvent

public final List<QName> getSupportedProcessingEvent()

Returns:

event list

setSupportedProcessingEvent

public final void setSupportedProcessingEvent(List<QName> list)

Parameters:

list - event list

addSupportedProcessingEvent

public final void addSupportedProcessingEvent(QName spe)

Parameters:

spe - event FQN

getSupportedPublishingEvent

public final List<QName> getSupportedPublishingEvent()

Returns:

event list

setSupportedPublishingEvent

public final void setSupportedPublishingEvent(List<QName> list)

Parameters:

list - event list

addSupportedPublishingEvent

public final void addSupportedPublishingEvent(QName spe)

Parameters:

spe - event FQN

getSupportedPublicRenderParameter

public final List<String> getSupportedPublicRenderParameter()

Returns:

param name list

addSupportedPublicRenderParameter

public final void addSupportedPublicRenderParameter(String srp)

Parameters:

srp - param name

setContainerRuntimeOption

public final void setContainerRuntimeOption(Map<String,String[]> containerRuntimeOption)

Parameters:

containerRuntimeOption1 - container runtime option map

getContainerRuntimeOption

public final Map<String,String[]> getContainerRuntimeOption()

Returns:

container runtime option map

addContainerRuntimeOption

public final void addContainerRuntimeOption(String name,
                                            String[] value)

Parameters:

name - name

value - value

addContainerRuntimeOption

public final void addContainerRuntimeOption(Map<String,String[]> containerRuntimeOption1)

Parameters:

containerRuntimeOption1 - container runtime option map