com.crossingchannels.portal.websphere.specification.jsr286.dom

Class PortletType

java.lang.Object

com.crossingchannels.portal.websphere.specification.jsr286.dom.PortletType

public class PortletType
extends java.lang.Object

The portlet element contains the declarative data of a portlet. Used in: portlet-app

Java class for portletType complex type.

The following schema fragment specifies the expected content contained within this class.

 <complexType name="portletType">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <element name="description" type="{http://java.sun.com/xml/ns/portlet/portlet-app_2_0.xsd}descriptionType" maxOccurs="unbounded" minOccurs="0"/>
         <element name="portlet-name" type="{http://java.sun.com/xml/ns/portlet/portlet-app_2_0.xsd}portlet-nameType"/>
         <element name="display-name" type="{http://java.sun.com/xml/ns/portlet/portlet-app_2_0.xsd}display-nameType" maxOccurs="unbounded" minOccurs="0"/>
         <element name="portlet-class" type="{http://java.sun.com/xml/ns/portlet/portlet-app_2_0.xsd}portlet-classType"/>
         <element name="init-param" type="{http://java.sun.com/xml/ns/portlet/portlet-app_2_0.xsd}init-paramType" maxOccurs="unbounded" minOccurs="0"/>
         <element name="expiration-cache" type="{http://java.sun.com/xml/ns/portlet/portlet-app_2_0.xsd}expiration-cacheType" minOccurs="0"/>
         <element name="cache-scope" type="{http://java.sun.com/xml/ns/portlet/portlet-app_2_0.xsd}cache-scopeType" minOccurs="0"/>
         <element name="supports" type="{http://java.sun.com/xml/ns/portlet/portlet-app_2_0.xsd}supportsType" maxOccurs="unbounded"/>
         <element name="supported-locale" type="{http://java.sun.com/xml/ns/portlet/portlet-app_2_0.xsd}supported-localeType" maxOccurs="unbounded" minOccurs="0"/>
         <element name="resource-bundle" type="{http://java.sun.com/xml/ns/portlet/portlet-app_2_0.xsd}resource-bundleType" minOccurs="0"/>
         <element name="portlet-info" type="{http://java.sun.com/xml/ns/portlet/portlet-app_2_0.xsd}portlet-infoType" minOccurs="0"/>
         <element name="portlet-preferences" type="{http://java.sun.com/xml/ns/portlet/portlet-app_2_0.xsd}portlet-preferencesType" minOccurs="0"/>
         <element name="security-role-ref" type="{http://java.sun.com/xml/ns/portlet/portlet-app_2_0.xsd}security-role-refType" maxOccurs="unbounded" minOccurs="0"/>
         <element name="supported-processing-event" type="{http://java.sun.com/xml/ns/portlet/portlet-app_2_0.xsd}event-definition-referenceType" maxOccurs="unbounded" minOccurs="0"/>
         <element name="supported-publishing-event" type="{http://java.sun.com/xml/ns/portlet/portlet-app_2_0.xsd}event-definition-referenceType" maxOccurs="unbounded" minOccurs="0"/>
         <element name="supported-public-render-parameter" type="{http://java.sun.com/xml/ns/portlet/portlet-app_2_0.xsd}string" maxOccurs="unbounded" minOccurs="0"/>
         <element name="container-runtime-option" type="{http://java.sun.com/xml/ns/portlet/portlet-app_2_0.xsd}container-runtime-optionType" maxOccurs="unbounded" minOccurs="0"/>
       </sequence>
       <attribute name="id" type="{http://java.sun.com/xml/ns/portlet/portlet-app_2_0.xsd}string" />
     </restriction>
   </complexContent>
 </complexType>
 

Field Summary

Fields

Modifier and Type	Field and Description
protected CacheScopeType	cacheScope
protected java.util.List<ContainerRuntimeOptionType>	containerRuntimeOption
protected java.util.List<DescriptionType>	description
protected java.util.List<DisplayNameType>	displayName
protected ExpirationCacheType	expirationCache
protected java.lang.String	id
protected java.util.List<InitParamType>	initParam
protected java.lang.String	portletClass
protected PortletInfoType	portletInfo
protected PortletNameType	portletName
protected PortletPreferencesType	portletPreferences
protected ResourceBundleType	resourceBundle
protected java.util.List<SecurityRoleRefType>	securityRoleRef
protected java.util.List<SupportedLocaleType>	supportedLocale
protected java.util.List<EventDefinitionReferenceType>	supportedProcessingEvent
protected java.util.List<java.lang.String>	supportedPublicRenderParameter
protected java.util.List<EventDefinitionReferenceType>	supportedPublishingEvent
protected java.util.List<SupportsType>	supports

Constructor Summary

Constructors

Constructor and Description
PortletType()

Method Summary

Methods

Modifier and Type	Method and Description
CacheScopeType	getCacheScope() Gets the value of the cacheScope property.
java.util.List<ContainerRuntimeOptionType>	getContainerRuntimeOption() Gets the value of the containerRuntimeOption property.
java.util.List<DescriptionType>	getDescription() Gets the value of the description property.
java.util.List<DisplayNameType>	getDisplayName() Gets the value of the displayName property.
ExpirationCacheType	getExpirationCache() Gets the value of the expirationCache property.
java.lang.String	getId() Gets the value of the id property.
java.util.List<InitParamType>	getInitParam() Gets the value of the initParam property.
java.lang.String	getPortletClass() Gets the value of the portletClass property.
PortletInfoType	getPortletInfo() Gets the value of the portletInfo property.
PortletNameType	getPortletName() Gets the value of the portletName property.
PortletPreferencesType	getPortletPreferences() Gets the value of the portletPreferences property.
ResourceBundleType	getResourceBundle() Gets the value of the resourceBundle property.
java.util.List<SecurityRoleRefType>	getSecurityRoleRef() Gets the value of the securityRoleRef property.
java.util.List<SupportedLocaleType>	getSupportedLocale() Gets the value of the supportedLocale property.
java.util.List<EventDefinitionReferenceType>	getSupportedProcessingEvent() Gets the value of the supportedProcessingEvent property.
java.util.List<java.lang.String>	getSupportedPublicRenderParameter() Gets the value of the supportedPublicRenderParameter property.
java.util.List<EventDefinitionReferenceType>	getSupportedPublishingEvent() Gets the value of the supportedPublishingEvent property.
java.util.List<SupportsType>	getSupports() Gets the value of the supports property.
void	setCacheScope(CacheScopeType value) Sets the value of the cacheScope property.
void	setExpirationCache(ExpirationCacheType value) Sets the value of the expirationCache property.
void	setId(java.lang.String value) Sets the value of the id property.
void	setPortletClass(java.lang.String value) Sets the value of the portletClass property.
void	setPortletInfo(PortletInfoType value) Sets the value of the portletInfo property.
void	setPortletName(PortletNameType value) Sets the value of the portletName property.
void	setPortletPreferences(PortletPreferencesType value) Sets the value of the portletPreferences property.
void	setResourceBundle(ResourceBundleType value) Sets the value of the resourceBundle property.

Methods inherited from class java.lang.Object

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

Field Detail

description

protected java.util.List<DescriptionType> description

portletName

protected PortletNameType portletName

displayName

protected java.util.List<DisplayNameType> displayName

portletClass

protected java.lang.String portletClass

initParam

protected java.util.List<InitParamType> initParam

expirationCache

protected ExpirationCacheType expirationCache

cacheScope

protected CacheScopeType cacheScope

supports

protected java.util.List<SupportsType> supports

supportedLocale

protected java.util.List<SupportedLocaleType> supportedLocale

resourceBundle

protected ResourceBundleType resourceBundle

portletInfo

protected PortletInfoType portletInfo

portletPreferences

protected PortletPreferencesType portletPreferences

securityRoleRef

protected java.util.List<SecurityRoleRefType> securityRoleRef

supportedProcessingEvent

protected java.util.List<EventDefinitionReferenceType> supportedProcessingEvent

supportedPublishingEvent

protected java.util.List<EventDefinitionReferenceType> supportedPublishingEvent

supportedPublicRenderParameter

protected java.util.List<java.lang.String> supportedPublicRenderParameter

containerRuntimeOption

protected java.util.List<ContainerRuntimeOptionType> containerRuntimeOption

id

protected java.lang.String id

Constructor Detail

PortletType

public PortletType()

Method Detail

getDescription

public java.util.List<DescriptionType> getDescription()

Gets the value of the description property.

This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the description property.

For example, to add a new item, do as follows:

    getDescription().add(newItem);
 

Objects of the following type(s) are allowed in the list DescriptionType

getPortletName

public PortletNameType getPortletName()

Gets the value of the portletName property.

Returns:

possible object is PortletNameType

setPortletName

public void setPortletName(PortletNameType value)

Sets the value of the portletName property.

Parameters:

value - allowed object is PortletNameType

getDisplayName

public java.util.List<DisplayNameType> getDisplayName()

Gets the value of the displayName property.

This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the displayName property.

For example, to add a new item, do as follows:

    getDisplayName().add(newItem);
 

Objects of the following type(s) are allowed in the list DisplayNameType

getPortletClass

public java.lang.String getPortletClass()

Gets the value of the portletClass property.

Returns:

possible object is String

setPortletClass

public void setPortletClass(java.lang.String value)

Sets the value of the portletClass property.

Parameters:

value - allowed object is String

getInitParam

public java.util.List<InitParamType> getInitParam()

Gets the value of the initParam property.

This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the initParam property.

For example, to add a new item, do as follows:

    getInitParam().add(newItem);
 

Objects of the following type(s) are allowed in the list InitParamType

getExpirationCache

public ExpirationCacheType getExpirationCache()

Gets the value of the expirationCache property.

Returns:

possible object is ExpirationCacheType

setExpirationCache

public void setExpirationCache(ExpirationCacheType value)

Sets the value of the expirationCache property.

Parameters:

value - allowed object is ExpirationCacheType

getCacheScope

public CacheScopeType getCacheScope()

Gets the value of the cacheScope property.

Returns:

possible object is CacheScopeType

setCacheScope

public void setCacheScope(CacheScopeType value)

Sets the value of the cacheScope property.

Parameters:

value - allowed object is CacheScopeType

getSupports

public java.util.List<SupportsType> getSupports()

Gets the value of the supports property.

This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the supports property.

For example, to add a new item, do as follows:

    getSupports().add(newItem);
 

Objects of the following type(s) are allowed in the list SupportsType

getSupportedLocale

public java.util.List<SupportedLocaleType> getSupportedLocale()

Gets the value of the supportedLocale property.

This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the supportedLocale property.

For example, to add a new item, do as follows:

    getSupportedLocale().add(newItem);
 

Objects of the following type(s) are allowed in the list SupportedLocaleType

getResourceBundle

public ResourceBundleType getResourceBundle()

Gets the value of the resourceBundle property.

Returns:

possible object is ResourceBundleType

setResourceBundle

public void setResourceBundle(ResourceBundleType value)

Sets the value of the resourceBundle property.

Parameters:

value - allowed object is ResourceBundleType

getPortletInfo

public PortletInfoType getPortletInfo()

Gets the value of the portletInfo property.

Returns:

possible object is PortletInfoType

setPortletInfo

public void setPortletInfo(PortletInfoType value)

Sets the value of the portletInfo property.

Parameters:

value - allowed object is PortletInfoType

getPortletPreferences

public PortletPreferencesType getPortletPreferences()

Gets the value of the portletPreferences property.

Returns:

possible object is PortletPreferencesType

setPortletPreferences

public void setPortletPreferences(PortletPreferencesType value)

Sets the value of the portletPreferences property.

Parameters:

value - allowed object is PortletPreferencesType

getSecurityRoleRef

public java.util.List<SecurityRoleRefType> getSecurityRoleRef()

Gets the value of the securityRoleRef property.

This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the securityRoleRef property.

For example, to add a new item, do as follows:

    getSecurityRoleRef().add(newItem);
 

Objects of the following type(s) are allowed in the list SecurityRoleRefType

getSupportedProcessingEvent

public java.util.List<EventDefinitionReferenceType> getSupportedProcessingEvent()

Gets the value of the supportedProcessingEvent property.

This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the supportedProcessingEvent property.

For example, to add a new item, do as follows:

    getSupportedProcessingEvent().add(newItem);
 

Objects of the following type(s) are allowed in the list EventDefinitionReferenceType

getSupportedPublishingEvent

public java.util.List<EventDefinitionReferenceType> getSupportedPublishingEvent()

Gets the value of the supportedPublishingEvent property.

This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the supportedPublishingEvent property.

For example, to add a new item, do as follows:

    getSupportedPublishingEvent().add(newItem);
 

Objects of the following type(s) are allowed in the list EventDefinitionReferenceType

getSupportedPublicRenderParameter

public java.util.List<java.lang.String> getSupportedPublicRenderParameter()

Gets the value of the supportedPublicRenderParameter property.

This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the supportedPublicRenderParameter property.

For example, to add a new item, do as follows:

    getSupportedPublicRenderParameter().add(newItem);
 

Objects of the following type(s) are allowed in the list String

getContainerRuntimeOption

public java.util.List<ContainerRuntimeOptionType> getContainerRuntimeOption()

Gets the value of the containerRuntimeOption property.

This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the containerRuntimeOption property.

For example, to add a new item, do as follows:

    getContainerRuntimeOption().add(newItem);
 

Objects of the following type(s) are allowed in the list ContainerRuntimeOptionType

getId

public java.lang.String getId()

Gets the value of the id property.

Returns:

possible object is String

setId

public void setId(java.lang.String value)

Sets the value of the id property.

Parameters:

value - allowed object is String