org.jboss.shrinkwrap.descriptor.api.portletapp20
Interface PortletDescriptor

All Superinterfaces:

Descriptor, DescriptorNamespace<PortletDescriptor>

public interface PortletDescriptor
extends Descriptor, DescriptorNamespace<PortletDescriptor>

This deployment descriptor provides the functionalities as described in the specification

Example:

PortletDescriptor descriptor = Descriptors.create(PortletDescriptor.class);

Since:

Generation date :2012-05-09T23:45:02.086-07:00

Author:

Ralf Battenfeld, Andrew Lee Rubinger

Method Summary

ContainerRuntimeOptionType<PortletDescriptor>	createContainerRuntimeOption() Creates a new container-runtime-option element
CustomPortletModeType<PortletDescriptor>	createCustomPortletMode() Creates a new custom-portlet-mode element
CustomWindowStateType<PortletDescriptor>	createCustomWindowState() Creates a new custom-window-state element
EventDefinitionType<PortletDescriptor>	createEventDefinition() Creates a new event-definition element
FilterType<PortletDescriptor>	createFilter() Creates a new filter element
FilterMappingType<PortletDescriptor>	createFilterMapping() Creates a new filter-mapping element
ListenerType<PortletDescriptor>	createListener() Creates a new listener element
PortletType<PortletDescriptor>	createPortlet() Creates a new portlet element
PublicRenderParameterType<PortletDescriptor>	createPublicRenderParameter() Creates a new public-render-parameter element
SecurityConstraintType<PortletDescriptor>	createSecurityConstraint() Creates a new security-constraint element
UserAttributeType<PortletDescriptor>	createUserAttribute() Creates a new user-attribute element
PortletDescriptor	defaultNamespace(String defaultNamespace) Sets the default-namespace element
List<ContainerRuntimeOptionType<PortletDescriptor>>	getAllContainerRuntimeOption() Returns all container-runtime-option elements
List<CustomPortletModeType<PortletDescriptor>>	getAllCustomPortletMode() Returns all custom-portlet-mode elements
List<CustomWindowStateType<PortletDescriptor>>	getAllCustomWindowState() Returns all custom-window-state elements
List<EventDefinitionType<PortletDescriptor>>	getAllEventDefinition() Returns all event-definition elements
List<FilterType<PortletDescriptor>>	getAllFilter() Returns all filter elements
List<FilterMappingType<PortletDescriptor>>	getAllFilterMapping() Returns all filter-mapping elements
List<ListenerType<PortletDescriptor>>	getAllListener() Returns all listener elements
List<PortletType<PortletDescriptor>>	getAllPortlet() Returns all portlet elements
List<PublicRenderParameterType<PortletDescriptor>>	getAllPublicRenderParameter() Returns all public-render-parameter elements
List<SecurityConstraintType<PortletDescriptor>>	getAllSecurityConstraint() Returns all security-constraint elements
List<UserAttributeType<PortletDescriptor>>	getAllUserAttribute() Returns all user-attribute elements
String	getDefaultNamespace() Returns the default-namespace element
String	getId() Returns the id attribute
ContainerRuntimeOptionType<PortletDescriptor>	getOrCreateContainerRuntimeOption() If not already created, a new container-runtime-option element will be created and returned.
CustomPortletModeType<PortletDescriptor>	getOrCreateCustomPortletMode() If not already created, a new custom-portlet-mode element will be created and returned.
CustomWindowStateType<PortletDescriptor>	getOrCreateCustomWindowState() If not already created, a new custom-window-state element will be created and returned.
EventDefinitionType<PortletDescriptor>	getOrCreateEventDefinition() If not already created, a new event-definition element will be created and returned.
FilterType<PortletDescriptor>	getOrCreateFilter() If not already created, a new filter element will be created and returned.
FilterMappingType<PortletDescriptor>	getOrCreateFilterMapping() If not already created, a new filter-mapping element will be created and returned.
ListenerType<PortletDescriptor>	getOrCreateListener() If not already created, a new listener element will be created and returned.
PortletType<PortletDescriptor>	getOrCreatePortlet() If not already created, a new portlet element will be created and returned.
PublicRenderParameterType<PortletDescriptor>	getOrCreatePublicRenderParameter() If not already created, a new public-render-parameter element will be created and returned.
SecurityConstraintType<PortletDescriptor>	getOrCreateSecurityConstraint() If not already created, a new security-constraint element will be created and returned.
UserAttributeType<PortletDescriptor>	getOrCreateUserAttribute() If not already created, a new user-attribute element will be created and returned.
String	getResourceBundle() Returns the resource-bundle element
String	getVersion() Returns the version attribute
PortletDescriptor	id(String id) Sets the id attribute
PortletDescriptor	removeAllContainerRuntimeOption() Removes all container-runtime-option elements
PortletDescriptor	removeAllCustomPortletMode() Removes all custom-portlet-mode elements
PortletDescriptor	removeAllCustomWindowState() Removes all custom-window-state elements
PortletDescriptor	removeAllEventDefinition() Removes all event-definition elements
PortletDescriptor	removeAllFilter() Removes all filter elements
PortletDescriptor	removeAllFilterMapping() Removes all filter-mapping elements
PortletDescriptor	removeAllListener() Removes all listener elements
PortletDescriptor	removeAllPortlet() Removes all portlet elements
PortletDescriptor	removeAllPublicRenderParameter() Removes all public-render-parameter elements
PortletDescriptor	removeAllSecurityConstraint() Removes all security-constraint elements
PortletDescriptor	removeAllUserAttribute() Removes all user-attribute elements
PortletDescriptor	removeDefaultNamespace() Removes the default-namespace element
PortletDescriptor	removeId() Removes the id attribute
PortletDescriptor	removeResourceBundle() Removes the resource-bundle element
PortletDescriptor	removeVersion() Removes the version attribute
PortletDescriptor	resourceBundle(String resourceBundle) Sets the resource-bundle element
PortletDescriptor	version(String version) Sets the version attribute

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

exportAsString, exportTo, getDescriptorName

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

addDefaultNamespaces, addNamespace, getNamespaces, removeAllNamespaces

Method Detail

getOrCreatePortlet

PortletType<PortletDescriptor> getOrCreatePortlet()

If not already created, a new portlet element will be created and returned. Otherwise, the first existing portlet element will be returned.

Returns:

the instance defined for the element portlet

createPortlet

PortletType<PortletDescriptor> createPortlet()

Creates a new portlet element

Returns:

the new created instance of PortletType

getAllPortlet

List<PortletType<PortletDescriptor>> getAllPortlet()

Returns all portlet elements

Returns:

list of portlet

removeAllPortlet

PortletDescriptor removeAllPortlet()

Removes all portlet elements

Returns:

the current instance of PortletType

getOrCreateCustomPortletMode

CustomPortletModeType<PortletDescriptor> getOrCreateCustomPortletMode()

If not already created, a new custom-portlet-mode element will be created and returned. Otherwise, the first existing custom-portlet-mode element will be returned.

Returns:

the instance defined for the element custom-portlet-mode

createCustomPortletMode

CustomPortletModeType<PortletDescriptor> createCustomPortletMode()

Creates a new custom-portlet-mode element

Returns:

the new created instance of CustomPortletModeType

getAllCustomPortletMode

List<CustomPortletModeType<PortletDescriptor>> getAllCustomPortletMode()

Returns all custom-portlet-mode elements

Returns:

list of custom-portlet-mode

removeAllCustomPortletMode

PortletDescriptor removeAllCustomPortletMode()

Removes all custom-portlet-mode elements

Returns:

the current instance of CustomPortletModeType

getOrCreateCustomWindowState

CustomWindowStateType<PortletDescriptor> getOrCreateCustomWindowState()

If not already created, a new custom-window-state element will be created and returned. Otherwise, the first existing custom-window-state element will be returned.

Returns:

the instance defined for the element custom-window-state

createCustomWindowState

CustomWindowStateType<PortletDescriptor> createCustomWindowState()

Creates a new custom-window-state element

Returns:

the new created instance of CustomWindowStateType

getAllCustomWindowState

List<CustomWindowStateType<PortletDescriptor>> getAllCustomWindowState()

Returns all custom-window-state elements

Returns:

list of custom-window-state

removeAllCustomWindowState

PortletDescriptor removeAllCustomWindowState()

Removes all custom-window-state elements

Returns:

the current instance of CustomWindowStateType

getOrCreateUserAttribute

UserAttributeType<PortletDescriptor> getOrCreateUserAttribute()

If not already created, a new user-attribute element will be created and returned. Otherwise, the first existing user-attribute element will be returned.

Returns:

the instance defined for the element user-attribute

createUserAttribute

UserAttributeType<PortletDescriptor> createUserAttribute()

Creates a new user-attribute element

Returns:

the new created instance of UserAttributeType

getAllUserAttribute

List<UserAttributeType<PortletDescriptor>> getAllUserAttribute()

Returns all user-attribute elements

Returns:

list of user-attribute

removeAllUserAttribute

PortletDescriptor removeAllUserAttribute()

Removes all user-attribute elements

Returns:

the current instance of UserAttributeType

getOrCreateSecurityConstraint

SecurityConstraintType<PortletDescriptor> getOrCreateSecurityConstraint()

If not already created, a new security-constraint element will be created and returned. Otherwise, the first existing security-constraint element will be returned.

Returns:

the instance defined for the element security-constraint

createSecurityConstraint

SecurityConstraintType<PortletDescriptor> createSecurityConstraint()

Creates a new security-constraint element

Returns:

the new created instance of SecurityConstraintType

getAllSecurityConstraint

List<SecurityConstraintType<PortletDescriptor>> getAllSecurityConstraint()

Returns all security-constraint elements

Returns:

list of security-constraint

removeAllSecurityConstraint

PortletDescriptor removeAllSecurityConstraint()

Removes all security-constraint elements

Returns:

the current instance of SecurityConstraintType

resourceBundle

PortletDescriptor resourceBundle(String resourceBundle)

Sets the resource-bundle element

Parameters:

resourceBundle - the value for the element resource-bundle

Returns:

the current instance of PortletDescriptor

getResourceBundle

String getResourceBundle()

Returns the resource-bundle element

Returns:

the node defined for the element resource-bundle

removeResourceBundle

PortletDescriptor removeResourceBundle()

Removes the resource-bundle element

Returns:

the current instance of PortletDescriptor

getOrCreateFilter

FilterType<PortletDescriptor> getOrCreateFilter()

If not already created, a new filter element will be created and returned. Otherwise, the first existing filter element will be returned.

Returns:

the instance defined for the element filter

createFilter

FilterType<PortletDescriptor> createFilter()

Creates a new filter element

Returns:

the new created instance of FilterType

getAllFilter

List<FilterType<PortletDescriptor>> getAllFilter()

Returns all filter elements

Returns:

list of filter

removeAllFilter

PortletDescriptor removeAllFilter()

Removes all filter elements

Returns:

the current instance of FilterType

getOrCreateFilterMapping

FilterMappingType<PortletDescriptor> getOrCreateFilterMapping()

If not already created, a new filter-mapping element will be created and returned. Otherwise, the first existing filter-mapping element will be returned.

Returns:

the instance defined for the element filter-mapping

createFilterMapping

FilterMappingType<PortletDescriptor> createFilterMapping()

Creates a new filter-mapping element

Returns:

the new created instance of FilterMappingType

getAllFilterMapping

List<FilterMappingType<PortletDescriptor>> getAllFilterMapping()

Returns all filter-mapping elements

Returns:

list of filter-mapping

removeAllFilterMapping

PortletDescriptor removeAllFilterMapping()

Removes all filter-mapping elements

Returns:

the current instance of FilterMappingType

defaultNamespace

PortletDescriptor defaultNamespace(String defaultNamespace)

Sets the default-namespace element

Parameters:

defaultNamespace - the value for the element default-namespace

Returns:

the current instance of PortletDescriptor

getDefaultNamespace

String getDefaultNamespace()

Returns the default-namespace element

Returns:

the node defined for the element default-namespace

removeDefaultNamespace

PortletDescriptor removeDefaultNamespace()

Removes the default-namespace element

Returns:

the current instance of PortletDescriptor

getOrCreateEventDefinition

EventDefinitionType<PortletDescriptor> getOrCreateEventDefinition()

If not already created, a new event-definition element will be created and returned. Otherwise, the first existing event-definition element will be returned.

Returns:

the instance defined for the element event-definition

createEventDefinition

EventDefinitionType<PortletDescriptor> createEventDefinition()

Creates a new event-definition element

Returns:

the new created instance of EventDefinitionType

getAllEventDefinition

List<EventDefinitionType<PortletDescriptor>> getAllEventDefinition()

Returns all event-definition elements

Returns:

list of event-definition

removeAllEventDefinition

PortletDescriptor removeAllEventDefinition()

Removes all event-definition elements

Returns:

the current instance of EventDefinitionType

getOrCreatePublicRenderParameter

PublicRenderParameterType<PortletDescriptor> getOrCreatePublicRenderParameter()

If not already created, a new public-render-parameter element will be created and returned. Otherwise, the first existing public-render-parameter element will be returned.

Returns:

the instance defined for the element public-render-parameter

createPublicRenderParameter

PublicRenderParameterType<PortletDescriptor> createPublicRenderParameter()

Creates a new public-render-parameter element

Returns:

the new created instance of PublicRenderParameterType

getAllPublicRenderParameter

List<PublicRenderParameterType<PortletDescriptor>> getAllPublicRenderParameter()

Returns all public-render-parameter elements

Returns:

list of public-render-parameter

removeAllPublicRenderParameter

PortletDescriptor removeAllPublicRenderParameter()

Removes all public-render-parameter elements

Returns:

the current instance of PublicRenderParameterType

getOrCreateListener

ListenerType<PortletDescriptor> getOrCreateListener()

If not already created, a new listener element will be created and returned. Otherwise, the first existing listener element will be returned.

Returns:

the instance defined for the element listener

createListener

ListenerType<PortletDescriptor> createListener()

Creates a new listener element

Returns:

the new created instance of ListenerType

getAllListener

List<ListenerType<PortletDescriptor>> getAllListener()

Returns all listener elements

Returns:

list of listener

removeAllListener

PortletDescriptor removeAllListener()

Removes all listener elements

Returns:

the current instance of ListenerType

getOrCreateContainerRuntimeOption

ContainerRuntimeOptionType<PortletDescriptor> 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<PortletDescriptor> createContainerRuntimeOption()

Creates a new container-runtime-option element

Returns:

the new created instance of ContainerRuntimeOptionType

getAllContainerRuntimeOption

List<ContainerRuntimeOptionType<PortletDescriptor>> getAllContainerRuntimeOption()

Returns all container-runtime-option elements

Returns:

list of container-runtime-option

removeAllContainerRuntimeOption

PortletDescriptor removeAllContainerRuntimeOption()

Removes all container-runtime-option elements

Returns:

the current instance of ContainerRuntimeOptionType

version

PortletDescriptor version(String version)

Sets the version attribute

Parameters:

version - the value for the attribute version

Returns:

the current instance of PortletDescriptor

getVersion

String getVersion()

Returns the version attribute

Returns:

the value defined for the attribute version

removeVersion

PortletDescriptor removeVersion()

Removes the version attribute

Returns:

the current instance of PortletDescriptor

id

PortletDescriptor id(String id)

Sets the id attribute

Parameters:

id - the value for the attribute id

Returns:

the current instance of PortletDescriptor

getId

String getId()

Returns the id attribute

Returns:

the value defined for the attribute id

removeId

PortletDescriptor removeId()

Removes the id attribute

Returns:

the current instance of PortletDescriptor