org.jboss.shrinkwrap.descriptor.api.portletapp20
Interface PortletAppType<T>

All Superinterfaces:

Child<T>

public interface PortletAppType<T>
extends Child<T>

This interface defines the contract for the portlet-appType xsd type

Since:

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

Author:

Ralf Battenfeld, Andrew Lee Rubinger

Method Summary

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

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

up

Method Detail

getOrCreatePortlet

PortletType<PortletAppType<T>> 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<PortletAppType<T>> createPortlet()

Creates a new portlet element

Returns:

the new created instance of PortletType>

getAllPortlet

List<PortletType<PortletAppType<T>>> getAllPortlet()

Returns all portlet elements

Returns:

list of portlet

removeAllPortlet

PortletAppType<T> removeAllPortlet()

Removes all portlet elements

Returns:

the current instance of PortletType>

getOrCreateCustomPortletMode

CustomPortletModeType<PortletAppType<T>> 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<PortletAppType<T>> createCustomPortletMode()

Creates a new custom-portlet-mode element

Returns:

the new created instance of CustomPortletModeType>

getAllCustomPortletMode

List<CustomPortletModeType<PortletAppType<T>>> getAllCustomPortletMode()

Returns all custom-portlet-mode elements

Returns:

list of custom-portlet-mode

removeAllCustomPortletMode

PortletAppType<T> removeAllCustomPortletMode()

Removes all custom-portlet-mode elements

Returns:

the current instance of CustomPortletModeType>

getOrCreateCustomWindowState

CustomWindowStateType<PortletAppType<T>> 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<PortletAppType<T>> createCustomWindowState()

Creates a new custom-window-state element

Returns:

the new created instance of CustomWindowStateType>

getAllCustomWindowState

List<CustomWindowStateType<PortletAppType<T>>> getAllCustomWindowState()

Returns all custom-window-state elements

Returns:

list of custom-window-state

removeAllCustomWindowState

PortletAppType<T> removeAllCustomWindowState()

Removes all custom-window-state elements

Returns:

the current instance of CustomWindowStateType>

getOrCreateUserAttribute

UserAttributeType<PortletAppType<T>> 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<PortletAppType<T>> createUserAttribute()

Creates a new user-attribute element

Returns:

the new created instance of UserAttributeType>

getAllUserAttribute

List<UserAttributeType<PortletAppType<T>>> getAllUserAttribute()

Returns all user-attribute elements

Returns:

list of user-attribute

removeAllUserAttribute

PortletAppType<T> removeAllUserAttribute()

Removes all user-attribute elements

Returns:

the current instance of UserAttributeType>

getOrCreateSecurityConstraint

SecurityConstraintType<PortletAppType<T>> 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<PortletAppType<T>> createSecurityConstraint()

Creates a new security-constraint element

Returns:

the new created instance of SecurityConstraintType>

getAllSecurityConstraint

List<SecurityConstraintType<PortletAppType<T>>> getAllSecurityConstraint()

Returns all security-constraint elements

Returns:

list of security-constraint

removeAllSecurityConstraint

PortletAppType<T> removeAllSecurityConstraint()

Removes all security-constraint elements

Returns:

the current instance of SecurityConstraintType>

resourceBundle

PortletAppType<T> resourceBundle(String resourceBundle)

Sets the resource-bundle element

Parameters:

resourceBundle - the value for the element resource-bundle

Returns:

the current instance of PortletAppType

getResourceBundle

String getResourceBundle()

Returns the resource-bundle element

Returns:

the node defined for the element resource-bundle

removeResourceBundle

PortletAppType<T> removeResourceBundle()

Removes the resource-bundle element

Returns:

the current instance of PortletAppType

getOrCreateFilter

FilterType<PortletAppType<T>> 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<PortletAppType<T>> createFilter()

Creates a new filter element

Returns:

the new created instance of FilterType>

getAllFilter

List<FilterType<PortletAppType<T>>> getAllFilter()

Returns all filter elements

Returns:

list of filter

removeAllFilter

PortletAppType<T> removeAllFilter()

Removes all filter elements

Returns:

the current instance of FilterType>

getOrCreateFilterMapping

FilterMappingType<PortletAppType<T>> 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<PortletAppType<T>> createFilterMapping()

Creates a new filter-mapping element

Returns:

the new created instance of FilterMappingType>

getAllFilterMapping

List<FilterMappingType<PortletAppType<T>>> getAllFilterMapping()

Returns all filter-mapping elements

Returns:

list of filter-mapping

removeAllFilterMapping

PortletAppType<T> removeAllFilterMapping()

Removes all filter-mapping elements

Returns:

the current instance of FilterMappingType>

defaultNamespace

PortletAppType<T> defaultNamespace(String defaultNamespace)

Sets the default-namespace element

Parameters:

defaultNamespace - the value for the element default-namespace

Returns:

the current instance of PortletAppType

getDefaultNamespace

String getDefaultNamespace()

Returns the default-namespace element

Returns:

the node defined for the element default-namespace

removeDefaultNamespace

PortletAppType<T> removeDefaultNamespace()

Removes the default-namespace element

Returns:

the current instance of PortletAppType

getOrCreateEventDefinition

EventDefinitionType<PortletAppType<T>> 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<PortletAppType<T>> createEventDefinition()

Creates a new event-definition element

Returns:

the new created instance of EventDefinitionType>

getAllEventDefinition

List<EventDefinitionType<PortletAppType<T>>> getAllEventDefinition()

Returns all event-definition elements

Returns:

list of event-definition

removeAllEventDefinition

PortletAppType<T> removeAllEventDefinition()

Removes all event-definition elements

Returns:

the current instance of EventDefinitionType>

getOrCreatePublicRenderParameter

PublicRenderParameterType<PortletAppType<T>> 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<PortletAppType<T>> createPublicRenderParameter()

Creates a new public-render-parameter element

Returns:

the new created instance of PublicRenderParameterType>

getAllPublicRenderParameter

List<PublicRenderParameterType<PortletAppType<T>>> getAllPublicRenderParameter()

Returns all public-render-parameter elements

Returns:

list of public-render-parameter

removeAllPublicRenderParameter

PortletAppType<T> removeAllPublicRenderParameter()

Removes all public-render-parameter elements

Returns:

the current instance of PublicRenderParameterType>

getOrCreateListener

ListenerType<PortletAppType<T>> 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<PortletAppType<T>> createListener()

Creates a new listener element

Returns:

the new created instance of ListenerType>

getAllListener

List<ListenerType<PortletAppType<T>>> getAllListener()

Returns all listener elements

Returns:

list of listener

removeAllListener

PortletAppType<T> removeAllListener()

Removes all listener elements

Returns:

the current instance of ListenerType>

getOrCreateContainerRuntimeOption

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

Creates a new container-runtime-option element

Returns:

the new created instance of ContainerRuntimeOptionType>

getAllContainerRuntimeOption

List<ContainerRuntimeOptionType<PortletAppType<T>>> getAllContainerRuntimeOption()

Returns all container-runtime-option elements

Returns:

list of container-runtime-option

removeAllContainerRuntimeOption

PortletAppType<T> removeAllContainerRuntimeOption()

Removes all container-runtime-option elements

Returns:

the current instance of ContainerRuntimeOptionType>

version

PortletAppType<T> version(String version)

Sets the version attribute

Parameters:

version - the value for the attribute version

Returns:

the current instance of PortletAppType

getVersion

String getVersion()

Returns the version attribute

Returns:

the value defined for the attribute version

removeVersion

PortletAppType<T> removeVersion()

Removes the version attribute

Returns:

the current instance of PortletAppType

id

PortletAppType<T> id(String id)

Sets the id attribute

Parameters:

id - the value for the attribute id

Returns:

the current instance of PortletAppType

getId

String getId()

Returns the id attribute

Returns:

the value defined for the attribute id

removeId

PortletAppType<T> removeId()

Removes the id attribute

Returns:

the current instance of PortletAppType