net.sourceforge.ccxjc.it.model.priv.collections.novalueclass.portlet.app200
Interface PortletType

All Known Implementing Classes:

PortletTypeImpl

public interface PortletType

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>
 

Method Summary

CacheScopeType	getCacheScope() Gets the value of the cacheScope property.
List<ContainerRuntimeOptionType>	getContainerRuntimeOption() Gets the value of the containerRuntimeOption property.
List<DescriptionType>	getDescription() Gets the value of the description property.
List<DisplayNameType>	getDisplayName() Gets the value of the displayName property.
ExpirationCacheType	getExpirationCache() Gets the value of the expirationCache property.
String	getId() Gets the value of the id property.
List<InitParamType>	getInitParam() Gets the value of the initParam property.
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.
List<SecurityRoleRefType>	getSecurityRoleRef() Gets the value of the securityRoleRef property.
List<SupportedLocaleType>	getSupportedLocale() Gets the value of the supportedLocale property.
List<EventDefinitionReferenceType>	getSupportedProcessingEvent() Gets the value of the supportedProcessingEvent property.
List<String>	getSupportedPublicRenderParameter() Gets the value of the supportedPublicRenderParameter property.
List<EventDefinitionReferenceType>	getSupportedPublishingEvent() Gets the value of the supportedPublishingEvent property.
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(String value) Sets the value of the id property.
void	setPortletClass(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.

Method Detail

getDescription

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

PortletNameType getPortletName()

Gets the value of the portletName property.

Returns:

possible object is PortletNameType

setPortletName

void setPortletName(PortletNameType value)

Sets the value of the portletName property.

Parameters:

value - allowed object is PortletNameType

getDisplayName

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

String getPortletClass()

Gets the value of the portletClass property.

Returns:

possible object is String

setPortletClass

void setPortletClass(String value)

Sets the value of the portletClass property.

Parameters:

value - allowed object is String

getInitParam

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

ExpirationCacheType getExpirationCache()

Gets the value of the expirationCache property.

Returns:

possible object is ExpirationCacheType

setExpirationCache

void setExpirationCache(ExpirationCacheType value)

Sets the value of the expirationCache property.

Parameters:

value - allowed object is ExpirationCacheType

getCacheScope

CacheScopeType getCacheScope()

Gets the value of the cacheScope property.

Returns:

possible object is CacheScopeType

setCacheScope

void setCacheScope(CacheScopeType value)

Sets the value of the cacheScope property.

Parameters:

value - allowed object is CacheScopeType

getSupports

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

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

ResourceBundleType getResourceBundle()

Gets the value of the resourceBundle property.

Returns:

possible object is ResourceBundleType

setResourceBundle

void setResourceBundle(ResourceBundleType value)

Sets the value of the resourceBundle property.

Parameters:

value - allowed object is ResourceBundleType

getPortletInfo

PortletInfoType getPortletInfo()

Gets the value of the portletInfo property.

Returns:

possible object is PortletInfoType

setPortletInfo

void setPortletInfo(PortletInfoType value)

Sets the value of the portletInfo property.

Parameters:

value - allowed object is PortletInfoType

getPortletPreferences

PortletPreferencesType getPortletPreferences()

Gets the value of the portletPreferences property.

Returns:

possible object is PortletPreferencesType

setPortletPreferences

void setPortletPreferences(PortletPreferencesType value)

Sets the value of the portletPreferences property.

Parameters:

value - allowed object is PortletPreferencesType

getSecurityRoleRef

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

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

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

List<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

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

String getId()

Gets the value of the id property.

Returns:

possible object is String

setId

void setId(String value)

Sets the value of the id property.

Parameters:

value - allowed object is String