PortletType (ShrinkWrap Descriptors Aggregator 2.0.0-alpha-9 API)

All Superinterfaces:

Child<T>, PortletPortletCommonType<T,PortletType<T>,InitParamType<PortletType<T>>,SupportsType<PortletType<T>>,PortletInfoType<PortletType<T>>,PortletPreferencesType<PortletType<T>>,SecurityRoleRefType<PortletType<T>>,EventDefinitionReferenceType<PortletType<T>>,EventDefinitionReferenceType<PortletType<T>>,ContainerRuntimeOptionType<PortletType<T>>>
```
public interface PortletType<T>
extends Child<T>, PortletPortletCommonType<T,PortletType<T>,InitParamType<PortletType<T>>,SupportsType<PortletType<T>>,PortletInfoType<PortletType<T>>,PortletPreferencesType<PortletType<T>>,SecurityRoleRefType<PortletType<T>>,EventDefinitionReferenceType<PortletType<T>>,EventDefinitionReferenceType<PortletType<T>>,ContainerRuntimeOptionType<PortletType<T>>>
```
This interface defines the contract for the portletType xsd type

Author:

Ralf Battenfeld, Andrew Lee Rubinger, George Gastaldi

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`PortletType<T>`	`cacheScope(String cacheScope)` Sets the `cache-scope` element
`ContainerRuntimeOptionType<PortletType<T>>`	`createContainerRuntimeOption()` Creates a new `container-runtime-option` element
`InitParamType<PortletType<T>>`	`createInitParam()` Creates a new `init-param` element
`SecurityRoleRefType<PortletType<T>>`	`createSecurityRoleRef()` Creates a new `security-role-ref` element
`EventDefinitionReferenceType<PortletType<T>>`	`createSupportedProcessingEvent()` Creates a new `supported-processing-event` element
`EventDefinitionReferenceType<PortletType<T>>`	`createSupportedPublishingEvent()` Creates a new `supported-publishing-event` element
`SupportsType<PortletType<T>>`	`createSupports()` Creates a new `supports` element
`PortletType<T>`	`description(String... values)` Creates for all String objects representing `description` elements, a new `description` element
`PortletType<T>`	`displayName(String... values)` Creates for all String objects representing `display-name` elements, a new `display-name` element
`PortletType<T>`	`expirationCache(Integer expirationCache)` Sets the `expiration-cache` element
`List<ContainerRuntimeOptionType<PortletType<T>>>`	`getAllContainerRuntimeOption()` Returns all `container-runtime-option` elements
`List<String>`	`getAllDescription()` Returns all `description` elements
`List<String>`	`getAllDisplayName()` Returns all `display-name` elements
`List<InitParamType<PortletType<T>>>`	`getAllInitParam()` Returns all `init-param` elements
`List<SecurityRoleRefType<PortletType<T>>>`	`getAllSecurityRoleRef()` Returns all `security-role-ref` elements
`List<String>`	`getAllSupportedLocale()` Returns all `supported-locale` elements
`List<EventDefinitionReferenceType<PortletType<T>>>`	`getAllSupportedProcessingEvent()` Returns all `supported-processing-event` elements
`List<String>`	`getAllSupportedPublicRenderParameter()` Returns all `supported-public-render-parameter` elements
`List<EventDefinitionReferenceType<PortletType<T>>>`	`getAllSupportedPublishingEvent()` Returns all `supported-publishing-event` elements
`List<SupportsType<PortletType<T>>>`	`getAllSupports()` Returns all `supports` elements
`String`	`getCacheScope()` Returns the `cache-scope` element
`Integer`	`getExpirationCache()` Returns the `expiration-cache` element
`String`	`getId()` Returns the `id` attribute
`ContainerRuntimeOptionType<PortletType<T>>`	`getOrCreateContainerRuntimeOption()` If not already created, a new `container-runtime-option` element will be created and returned.
`InitParamType<PortletType<T>>`	`getOrCreateInitParam()` If not already created, a new `init-param` element will be created and returned.
`PortletInfoType<PortletType<T>>`	`getOrCreatePortletInfo()` If not already created, a new `portlet-info` element with the given value will be created.
`PortletPreferencesType<PortletType<T>>`	`getOrCreatePortletPreferences()` If not already created, a new `portlet-preferences` element with the given value will be created.
`SecurityRoleRefType<PortletType<T>>`	`getOrCreateSecurityRoleRef()` If not already created, a new `security-role-ref` element will be created and returned.
`EventDefinitionReferenceType<PortletType<T>>`	`getOrCreateSupportedProcessingEvent()` If not already created, a new `supported-processing-event` element will be created and returned.
`EventDefinitionReferenceType<PortletType<T>>`	`getOrCreateSupportedPublishingEvent()` If not already created, a new `supported-publishing-event` element will be created and returned.
`SupportsType<PortletType<T>>`	`getOrCreateSupports()` If not already created, a new `supports` element will be created and returned.
`String`	`getPortletClass()` Returns the `portlet-class` element
`String`	`getPortletName()` Returns the `portlet-name` element
`String`	`getResourceBundle()` Returns the `resource-bundle` element
`PortletType<T>`	`id(String id)` Sets the `id` attribute
`PortletType<T>`	`portletClass(String portletClass)` Sets the `portlet-class` element
`PortletType<T>`	`portletName(String portletName)` Sets the `portlet-name` element
`PortletType<T>`	`removeAllContainerRuntimeOption()` Removes all `container-runtime-option` elements
`PortletType<T>`	`removeAllDescription()` Removes the `description` element
`PortletType<T>`	`removeAllDisplayName()` Removes the `display-name` element
`PortletType<T>`	`removeAllInitParam()` Removes all `init-param` elements
`PortletType<T>`	`removeAllSecurityRoleRef()` Removes all `security-role-ref` elements
`PortletType<T>`	`removeAllSupportedLocale()` Removes the `supported-locale` element
`PortletType<T>`	`removeAllSupportedProcessingEvent()` Removes all `supported-processing-event` elements
`PortletType<T>`	`removeAllSupportedPublicRenderParameter()` Removes the `supported-public-render-parameter` element
`PortletType<T>`	`removeAllSupportedPublishingEvent()` Removes all `supported-publishing-event` elements
`PortletType<T>`	`removeAllSupports()` Removes all `supports` elements
`PortletType<T>`	`removeCacheScope()` Removes the `cache-scope` element
`PortletType<T>`	`removeExpirationCache()` Removes the `expiration-cache` element
`PortletType<T>`	`removeId()` Removes the `id` attribute
`PortletType<T>`	`removePortletClass()` Removes the `portlet-class` element
`PortletType<T>`	`removePortletInfo()` Removes the `portlet-info` element
`PortletType<T>`	`removePortletName()` Removes the `portlet-name` element
`PortletType<T>`	`removePortletPreferences()` Removes the `portlet-preferences` element
`PortletType<T>`	`removeResourceBundle()` Removes the `resource-bundle` element
`PortletType<T>`	`resourceBundle(String resourceBundle)` Sets the `resource-bundle` element
`PortletType<T>`	`supportedLocale(String... values)` Creates for all String objects representing `supported-locale` elements, a new `supported-locale` element
`PortletType<T>`	`supportedPublicRenderParameter(String... values)` Creates for all String objects representing `supported-public-render-parameter` elements, a new `supported-public-render-parameter` element

Methods inherited from interface org.jboss.shrinkwrap.descriptor.api.Child
up

- Method Detail
  - description
```
PortletType<T> description(String... values)
```
    Creates for all String objects representing description elements, a new description element
    
    Parameters:
    
    values - list of description objects
    
    Returns:
    
    the current instance of PortletType
  - getAllDescription
```
List<String> getAllDescription()
```
    Returns all description elements
    
    Returns:
    
    list of description
  - removeAllDescription
```
PortletType<T> removeAllDescription()
```
    Removes the description element
    
    Returns:
    
    the current instance of PortletType
  - portletName
```
PortletType<T> portletName(String portletName)
```
    Sets the portlet-name element
    
    Parameters:
    
    portletName - the value for the element portlet-name
    
    Returns:
    
    the current instance of PortletType
  - getPortletName
```
String getPortletName()
```
    Returns the portlet-name element
    
    Returns:
    
    the node defined for the element portlet-name
  - removePortletName
```
PortletType<T> removePortletName()
```
    Removes the portlet-name element
    
    Returns:
    
    the current instance of PortletType
  - displayName
```
PortletType<T> displayName(String... values)
```
    Creates for all String objects representing display-name elements, a new display-name element
    
    Parameters:
    
    values - list of display-name objects
    
    Returns:
    
    the current instance of PortletType
  - getAllDisplayName
```
List<String> getAllDisplayName()
```
    Returns all display-name elements
    
    Returns:
    
    list of display-name
  - removeAllDisplayName
```
PortletType<T> removeAllDisplayName()
```
    Removes the display-name element
    
    Returns:
    
    the current instance of PortletType
  - portletClass
```
PortletType<T> portletClass(String portletClass)
```
    Sets the portlet-class element
    
    Parameters:
    
    portletClass - the value for the element portlet-class
    
    Returns:
    
    the current instance of PortletType
  - getPortletClass
```
String getPortletClass()
```
    Returns the portlet-class element
    
    Returns:
    
    the node defined for the element portlet-class
  - removePortletClass
```
PortletType<T> removePortletClass()
```
    Removes the portlet-class element
    
    Returns:
    
    the current instance of PortletType
  - getOrCreateInitParam
```
InitParamType<PortletType<T>> getOrCreateInitParam()
```
    If not already created, a new init-param element will be created and returned. Otherwise, the first existing init-param element will be returned.
    
    Returns:
    
    the instance defined for the element init-param
  - createInitParam
```
InitParamType<PortletType<T>> createInitParam()
```
    Creates a new init-param element
    
    Returns:
    
    the new created instance of InitParamType>
  - getAllInitParam
```
List<InitParamType<PortletType<T>>> getAllInitParam()
```
    Returns all init-param elements
    
    Returns:
    
    list of init-param
  - removeAllInitParam
```
PortletType<T> removeAllInitParam()
```
    Removes all init-param elements
    
    Returns:
    
    the current instance of InitParamType>
  - expirationCache
```
PortletType<T> expirationCache(Integer expirationCache)
```
    Sets the expiration-cache element
    
    Parameters:
    
    expirationCache - the value for the element expiration-cache
    
    Returns:
    
    the current instance of PortletType
  - getExpirationCache
```
Integer getExpirationCache()
```
    Returns the expiration-cache element
    
    Returns:
    
    the node defined for the element expiration-cache
  - removeExpirationCache
```
PortletType<T> removeExpirationCache()
```
    Removes the expiration-cache element
    
    Returns:
    
    the current instance of PortletType
  - cacheScope
```
PortletType<T> cacheScope(String cacheScope)
```
    Sets the cache-scope element
    
    Parameters:
    
    cacheScope - the value for the element cache-scope
    
    Returns:
    
    the current instance of PortletType
  - getCacheScope
```
String getCacheScope()
```
    Returns the cache-scope element
    
    Returns:
    
    the node defined for the element cache-scope
  - removeCacheScope
```
PortletType<T> removeCacheScope()
```
    Removes the cache-scope element
    
    Returns:
    
    the current instance of PortletType
  - getOrCreateSupports
```
SupportsType<PortletType<T>> getOrCreateSupports()
```
    If not already created, a new supports element will be created and returned. Otherwise, the first existing supports element will be returned.
    
    Returns:
    
    the instance defined for the element supports
  - createSupports
```
SupportsType<PortletType<T>> createSupports()
```
    Creates a new supports element
    
    Returns:
    
    the new created instance of SupportsType>
  - getAllSupports
```
List<SupportsType<PortletType<T>>> getAllSupports()
```
    Returns all supports elements
    
    Returns:
    
    list of supports
  - removeAllSupports
```
PortletType<T> removeAllSupports()
```
    Removes all supports elements
    
    Returns:
    
    the current instance of SupportsType>
  - supportedLocale
```
PortletType<T> supportedLocale(String... values)
```
    Creates for all String objects representing supported-locale elements, a new supported-locale element
    
    Parameters:
    
    values - list of supported-locale objects
    
    Returns:
    
    the current instance of PortletType
  - getAllSupportedLocale
```
List<String> getAllSupportedLocale()
```
    Returns all supported-locale elements
    
    Returns:
    
    list of supported-locale
  - removeAllSupportedLocale
```
PortletType<T> removeAllSupportedLocale()
```
    Removes the supported-locale element
    
    Returns:
    
    the current instance of PortletType
  - resourceBundle
```
PortletType<T> resourceBundle(String resourceBundle)
```
    Sets the resource-bundle element
    
    Parameters:
    
    resourceBundle - the value for the element resource-bundle
    
    Returns:
    
    the current instance of PortletType
  - getResourceBundle
```
String getResourceBundle()
```
    Returns the resource-bundle element
    
    Returns:
    
    the node defined for the element resource-bundle
  - removeResourceBundle
```
PortletType<T> removeResourceBundle()
```
    Removes the resource-bundle element
    
    Returns:
    
    the current instance of PortletType
  - getOrCreatePortletInfo
```
PortletInfoType<PortletType<T>> getOrCreatePortletInfo()
```
    If not already created, a new portlet-info element with the given value will be created. Otherwise, the existing portlet-info element will be returned.
    
    Returns:
    
    a new or existing instance of PortletInfoType>
  - removePortletInfo
```
PortletType<T> removePortletInfo()
```
    Removes the portlet-info element
    
    Returns:
    
    the current instance of PortletType
  - getOrCreatePortletPreferences
```
PortletPreferencesType<PortletType<T>> getOrCreatePortletPreferences()
```
    If not already created, a new portlet-preferences element with the given value will be created. Otherwise, the existing portlet-preferences element will be returned.
    
    Returns:
    
    a new or existing instance of PortletPreferencesType>
  - removePortletPreferences
```
PortletType<T> removePortletPreferences()
```
    Removes the portlet-preferences element
    
    Returns:
    
    the current instance of PortletType
  - getOrCreateSecurityRoleRef
```
SecurityRoleRefType<PortletType<T>> getOrCreateSecurityRoleRef()
```
    If not already created, a new security-role-ref element will be created and returned. Otherwise, the first existing security-role-ref element will be returned.
    
    Returns:
    
    the instance defined for the element security-role-ref
  - createSecurityRoleRef
```
SecurityRoleRefType<PortletType<T>> createSecurityRoleRef()
```
    Creates a new security-role-ref element
    
    Returns:
    
    the new created instance of SecurityRoleRefType>
  - getAllSecurityRoleRef
```
List<SecurityRoleRefType<PortletType<T>>> getAllSecurityRoleRef()
```
    Returns all security-role-ref elements
    
    Returns:
    
    list of security-role-ref
  - removeAllSecurityRoleRef
```
PortletType<T> removeAllSecurityRoleRef()
```
    Removes all security-role-ref elements
    
    Returns:
    
    the current instance of SecurityRoleRefType>
  - getOrCreateSupportedProcessingEvent
```
EventDefinitionReferenceType<PortletType<T>> getOrCreateSupportedProcessingEvent()
```
    If not already created, a new supported-processing-event element will be created and returned. Otherwise, the first existing supported-processing-event element will be returned.
    
    Returns:
    
    the instance defined for the element supported-processing-event
  - createSupportedProcessingEvent
```
EventDefinitionReferenceType<PortletType<T>> createSupportedProcessingEvent()
```
    Creates a new supported-processing-event element
    
    Returns:
    
    the new created instance of EventDefinitionReferenceType>
  - getAllSupportedProcessingEvent
```
List<EventDefinitionReferenceType<PortletType<T>>> getAllSupportedProcessingEvent()
```
    Returns all supported-processing-event elements
    
    Returns:
    
    list of supported-processing-event
  - removeAllSupportedProcessingEvent
```
PortletType<T> removeAllSupportedProcessingEvent()
```
    Removes all supported-processing-event elements
    
    Returns:
    
    the current instance of EventDefinitionReferenceType>
  - getOrCreateSupportedPublishingEvent
```
EventDefinitionReferenceType<PortletType<T>> getOrCreateSupportedPublishingEvent()
```
    If not already created, a new supported-publishing-event element will be created and returned. Otherwise, the first existing supported-publishing-event element will be returned.
    
    Returns:
    
    the instance defined for the element supported-publishing-event
  - createSupportedPublishingEvent
```
EventDefinitionReferenceType<PortletType<T>> createSupportedPublishingEvent()
```
    Creates a new supported-publishing-event element
    
    Returns:
    
    the new created instance of EventDefinitionReferenceType>
  - getAllSupportedPublishingEvent
```
List<EventDefinitionReferenceType<PortletType<T>>> getAllSupportedPublishingEvent()
```
    Returns all supported-publishing-event elements
    
    Returns:
    
    list of supported-publishing-event
  - removeAllSupportedPublishingEvent
```
PortletType<T> removeAllSupportedPublishingEvent()
```
    Removes all supported-publishing-event elements
    
    Returns:
    
    the current instance of EventDefinitionReferenceType>
  - supportedPublicRenderParameter
```
PortletType<T> supportedPublicRenderParameter(String... values)
```
    Creates for all String objects representing supported-public-render-parameter elements, a new supported-public-render-parameter element
    
    Parameters:
    
    values - list of supported-public-render-parameter objects
    
    Returns:
    
    the current instance of PortletType
  - getAllSupportedPublicRenderParameter
```
List<String> getAllSupportedPublicRenderParameter()
```
    Returns all supported-public-render-parameter elements
    
    Returns:
    
    list of supported-public-render-parameter
  - removeAllSupportedPublicRenderParameter
```
PortletType<T> removeAllSupportedPublicRenderParameter()
```
    Removes the supported-public-render-parameter element
    
    Returns:
    
    the current instance of PortletType
  - getOrCreateContainerRuntimeOption
```
ContainerRuntimeOptionType<PortletType<T>> getOrCreateContainerRuntimeOption()
```
    If not already created, a new container-runtime-option element will be created and returned. Otherwise, the first existing container-runtime-option element will be returned.
    
    Returns:
    
    the instance defined for the element container-runtime-option
  - createContainerRuntimeOption
```
ContainerRuntimeOptionType<PortletType<T>> createContainerRuntimeOption()
```
    Creates a new container-runtime-option element
    
    Returns:
    
    the new created instance of ContainerRuntimeOptionType>
  - getAllContainerRuntimeOption
```
List<ContainerRuntimeOptionType<PortletType<T>>> getAllContainerRuntimeOption()
```
    Returns all container-runtime-option elements
    
    Returns:
    
    list of container-runtime-option
  - removeAllContainerRuntimeOption
```
PortletType<T> removeAllContainerRuntimeOption()
```
    Removes all container-runtime-option elements
    
    Returns:
    
    the current instance of ContainerRuntimeOptionType>
  - id
```
PortletType<T> id(String id)
```
    Sets the id attribute
    
    Parameters:
    
    id - the value for the attribute id
    
    Returns:
    
    the current instance of PortletType
  - getId
```
String getId()
```
    Returns the id attribute
    
    Returns:
    
    the value defined for the attribute id
  - removeId
```
PortletType<T> removeId()
```
    Removes the id attribute
    
    Returns:
    
    the current instance of PortletType

Interface PortletType<T>

Method Summary

Methods inherited from interface org.jboss.shrinkwrap.descriptor.api.Child

Method Detail

description

getAllDescription

removeAllDescription

portletName

getPortletName

removePortletName

displayName

getAllDisplayName

removeAllDisplayName

portletClass

getPortletClass

removePortletClass

getOrCreateInitParam

createInitParam

getAllInitParam

removeAllInitParam

expirationCache

getExpirationCache

removeExpirationCache

cacheScope

getCacheScope

removeCacheScope

getOrCreateSupports

createSupports

getAllSupports

removeAllSupports

supportedLocale

getAllSupportedLocale

removeAllSupportedLocale

resourceBundle

getResourceBundle

removeResourceBundle

getOrCreatePortletInfo

removePortletInfo

getOrCreatePortletPreferences

removePortletPreferences

getOrCreateSecurityRoleRef

createSecurityRoleRef

getAllSecurityRoleRef

removeAllSecurityRoleRef

getOrCreateSupportedProcessingEvent

createSupportedProcessingEvent

getAllSupportedProcessingEvent

removeAllSupportedProcessingEvent

getOrCreateSupportedPublishingEvent

createSupportedPublishingEvent

getAllSupportedPublishingEvent

removeAllSupportedPublishingEvent

supportedPublicRenderParameter

getAllSupportedPublicRenderParameter

removeAllSupportedPublicRenderParameter

getOrCreateContainerRuntimeOption

createContainerRuntimeOption

getAllContainerRuntimeOption

removeAllContainerRuntimeOption

id

getId

removeId