net.sourceforge.ccxjc.it.model.pub.indexed.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.
ContainerRuntimeOptionType[]	getContainerRuntimeOption()
ContainerRuntimeOptionType	getContainerRuntimeOption(int idx)
int	getContainerRuntimeOptionLength()
DescriptionType[]	getDescription()
DescriptionType	getDescription(int idx)
int	getDescriptionLength()
DisplayNameType[]	getDisplayName()
DisplayNameType	getDisplayName(int idx)
int	getDisplayNameLength()
ExpirationCacheType	getExpirationCache() Gets the value of the expirationCache property.
String	getId() Gets the value of the id property.
InitParamType[]	getInitParam()
InitParamType	getInitParam(int idx)
int	getInitParamLength()
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.
SecurityRoleRefType[]	getSecurityRoleRef()
SecurityRoleRefType	getSecurityRoleRef(int idx)
int	getSecurityRoleRefLength()
SupportedLocaleType[]	getSupportedLocale()
SupportedLocaleType	getSupportedLocale(int idx)
int	getSupportedLocaleLength()
EventDefinitionReferenceType[]	getSupportedProcessingEvent()
EventDefinitionReferenceType	getSupportedProcessingEvent(int idx)
int	getSupportedProcessingEventLength()
String[]	getSupportedPublicRenderParameter()
String	getSupportedPublicRenderParameter(int idx)
int	getSupportedPublicRenderParameterLength()
EventDefinitionReferenceType[]	getSupportedPublishingEvent()
EventDefinitionReferenceType	getSupportedPublishingEvent(int idx)
int	getSupportedPublishingEventLength()
SupportsType[]	getSupports()
SupportsType	getSupports(int idx)
int	getSupportsLength()
void	setCacheScope(CacheScopeType value) Sets the value of the cacheScope property.
void	setContainerRuntimeOption(ContainerRuntimeOptionType[] values)
ContainerRuntimeOptionType	setContainerRuntimeOption(int idx, ContainerRuntimeOptionType value)
void	setDescription(DescriptionType[] values)
DescriptionType	setDescription(int idx, DescriptionType value)
void	setDisplayName(DisplayNameType[] values)
DisplayNameType	setDisplayName(int idx, DisplayNameType value)
void	setExpirationCache(ExpirationCacheType value) Sets the value of the expirationCache property.
void	setId(String value) Sets the value of the id property.
void	setInitParam(InitParamType[] values)
InitParamType	setInitParam(int idx, InitParamType value)
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.
SecurityRoleRefType	setSecurityRoleRef(int idx, SecurityRoleRefType value)
void	setSecurityRoleRef(SecurityRoleRefType[] values)
SupportedLocaleType	setSupportedLocale(int idx, SupportedLocaleType value)
void	setSupportedLocale(SupportedLocaleType[] values)
void	setSupportedProcessingEvent(EventDefinitionReferenceType[] values)
EventDefinitionReferenceType	setSupportedProcessingEvent(int idx, EventDefinitionReferenceType value)
String	setSupportedPublicRenderParameter(int idx, String value)
void	setSupportedPublicRenderParameter(String[] values)
void	setSupportedPublishingEvent(EventDefinitionReferenceType[] values)
EventDefinitionReferenceType	setSupportedPublishingEvent(int idx, EventDefinitionReferenceType value)
SupportsType	setSupports(int idx, SupportsType value)
void	setSupports(SupportsType[] values)

Method Detail

getDescription

DescriptionType[] getDescription()

Returns:

array of DescriptionType

getDescription

DescriptionType getDescription(int idx)

Returns:

one of DescriptionType

getDescriptionLength

int getDescriptionLength()

setDescription

void setDescription(DescriptionType[] values)

Parameters:

values - allowed objects are DescriptionType

setDescription

DescriptionType setDescription(int idx,
                               DescriptionType value)

Parameters:

value - allowed object is 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

DisplayNameType[] getDisplayName()

Returns:

array of DisplayNameType

getDisplayName

DisplayNameType getDisplayName(int idx)

Returns:

one of DisplayNameType

getDisplayNameLength

int getDisplayNameLength()

setDisplayName

void setDisplayName(DisplayNameType[] values)

Parameters:

values - allowed objects are DisplayNameType

setDisplayName

DisplayNameType setDisplayName(int idx,
                               DisplayNameType value)

Parameters:

value - allowed object is 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

InitParamType[] getInitParam()

Returns:

array of InitParamType

getInitParam

InitParamType getInitParam(int idx)

Returns:

one of InitParamType

getInitParamLength

int getInitParamLength()

setInitParam

void setInitParam(InitParamType[] values)

Parameters:

values - allowed objects are InitParamType

setInitParam

InitParamType setInitParam(int idx,
                           InitParamType value)

Parameters:

value - allowed object is 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

SupportsType[] getSupports()

Returns:

array of SupportsType

getSupports

SupportsType getSupports(int idx)

Returns:

one of SupportsType

getSupportsLength

int getSupportsLength()

setSupports

void setSupports(SupportsType[] values)

Parameters:

values - allowed objects are SupportsType

setSupports

SupportsType setSupports(int idx,
                         SupportsType value)

Parameters:

value - allowed object is SupportsType

getSupportedLocale

SupportedLocaleType[] getSupportedLocale()

Returns:

array of SupportedLocaleType

getSupportedLocale

SupportedLocaleType getSupportedLocale(int idx)

Returns:

one of SupportedLocaleType

getSupportedLocaleLength

int getSupportedLocaleLength()

setSupportedLocale

void setSupportedLocale(SupportedLocaleType[] values)

Parameters:

values - allowed objects are SupportedLocaleType

setSupportedLocale

SupportedLocaleType setSupportedLocale(int idx,
                                       SupportedLocaleType value)

Parameters:

value - allowed object is 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

SecurityRoleRefType[] getSecurityRoleRef()

Returns:

array of SecurityRoleRefType

getSecurityRoleRef

SecurityRoleRefType getSecurityRoleRef(int idx)

Returns:

one of SecurityRoleRefType

getSecurityRoleRefLength

int getSecurityRoleRefLength()

setSecurityRoleRef

void setSecurityRoleRef(SecurityRoleRefType[] values)

Parameters:

values - allowed objects are SecurityRoleRefType

setSecurityRoleRef

SecurityRoleRefType setSecurityRoleRef(int idx,
                                       SecurityRoleRefType value)

Parameters:

value - allowed object is SecurityRoleRefType

getSupportedProcessingEvent

EventDefinitionReferenceType[] getSupportedProcessingEvent()

Returns:

array of EventDefinitionReferenceType

getSupportedProcessingEvent

EventDefinitionReferenceType getSupportedProcessingEvent(int idx)

Returns:

one of EventDefinitionReferenceType

getSupportedProcessingEventLength

int getSupportedProcessingEventLength()

setSupportedProcessingEvent

void setSupportedProcessingEvent(EventDefinitionReferenceType[] values)

Parameters:

values - allowed objects are EventDefinitionReferenceType

setSupportedProcessingEvent

EventDefinitionReferenceType setSupportedProcessingEvent(int idx,
                                                         EventDefinitionReferenceType value)

Parameters:

value - allowed object is EventDefinitionReferenceType

getSupportedPublishingEvent

EventDefinitionReferenceType[] getSupportedPublishingEvent()

Returns:

array of EventDefinitionReferenceType

getSupportedPublishingEvent

EventDefinitionReferenceType getSupportedPublishingEvent(int idx)

Returns:

one of EventDefinitionReferenceType

getSupportedPublishingEventLength

int getSupportedPublishingEventLength()

setSupportedPublishingEvent

void setSupportedPublishingEvent(EventDefinitionReferenceType[] values)

Parameters:

values - allowed objects are EventDefinitionReferenceType

setSupportedPublishingEvent

EventDefinitionReferenceType setSupportedPublishingEvent(int idx,
                                                         EventDefinitionReferenceType value)

Parameters:

value - allowed object is EventDefinitionReferenceType

getSupportedPublicRenderParameter

String[] getSupportedPublicRenderParameter()

Returns:

array of String

getSupportedPublicRenderParameter

String getSupportedPublicRenderParameter(int idx)

Returns:

one of String

getSupportedPublicRenderParameterLength

int getSupportedPublicRenderParameterLength()

setSupportedPublicRenderParameter

void setSupportedPublicRenderParameter(String[] values)

Parameters:

values - allowed objects are String

setSupportedPublicRenderParameter

String setSupportedPublicRenderParameter(int idx,
                                         String value)

Parameters:

value - allowed object is String

getContainerRuntimeOption

ContainerRuntimeOptionType[] getContainerRuntimeOption()

Returns:

array of ContainerRuntimeOptionType

getContainerRuntimeOption

ContainerRuntimeOptionType getContainerRuntimeOption(int idx)

Returns:

one of ContainerRuntimeOptionType

getContainerRuntimeOptionLength

int getContainerRuntimeOptionLength()

setContainerRuntimeOption

void setContainerRuntimeOption(ContainerRuntimeOptionType[] values)

Parameters:

values - allowed objects are ContainerRuntimeOptionType

setContainerRuntimeOption

ContainerRuntimeOptionType setContainerRuntimeOption(int idx,
                                                     ContainerRuntimeOptionType value)

Parameters:

value - allowed object is 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