public interface PortletDescriptor extends Descriptor, DescriptorNamespace<PortletDescriptor>, PortletCommonDescriptor<PortletDescriptor,PortletType<PortletDescriptor>,CustomPortletModeType<PortletDescriptor>,CustomWindowStateType<PortletDescriptor>,UserAttributeType<PortletDescriptor>,SecurityConstraintType<PortletDescriptor>,FilterType<PortletDescriptor>,FilterMappingType<PortletDescriptor>,EventDefinitionType<PortletDescriptor>,PublicRenderParameterType<PortletDescriptor>,ListenerType<PortletDescriptor>,ContainerRuntimeOptionType<PortletDescriptor>>
This deployment descriptor provides the functionalities as described in the specification
Example:
PortletDescriptor descriptor = Descriptors.create(PortletDescriptor.class);
Modifier and Type | Method and Description |
---|---|
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 |
addDefaultNamespaces, addNamespace, getNamespaces, removeAllNamespaces
exportAsString, exportTo, getDescriptorName
PortletType<PortletDescriptor> getOrCreatePortlet()
portlet
element will be created and returned.
Otherwise, the first existing portlet
element will be returned.portlet
PortletType<PortletDescriptor> createPortlet()
portlet
elementPortletType
List<PortletType<PortletDescriptor>> getAllPortlet()
portlet
elementsportlet
PortletDescriptor removeAllPortlet()
portlet
elementsPortletType
CustomPortletModeType<PortletDescriptor> getOrCreateCustomPortletMode()
custom-portlet-mode
element will be created and returned.
Otherwise, the first existing custom-portlet-mode
element will be returned.custom-portlet-mode
CustomPortletModeType<PortletDescriptor> createCustomPortletMode()
custom-portlet-mode
elementCustomPortletModeType
List<CustomPortletModeType<PortletDescriptor>> getAllCustomPortletMode()
custom-portlet-mode
elementscustom-portlet-mode
PortletDescriptor removeAllCustomPortletMode()
custom-portlet-mode
elementsCustomPortletModeType
CustomWindowStateType<PortletDescriptor> getOrCreateCustomWindowState()
custom-window-state
element will be created and returned.
Otherwise, the first existing custom-window-state
element will be returned.custom-window-state
CustomWindowStateType<PortletDescriptor> createCustomWindowState()
custom-window-state
elementCustomWindowStateType
List<CustomWindowStateType<PortletDescriptor>> getAllCustomWindowState()
custom-window-state
elementscustom-window-state
PortletDescriptor removeAllCustomWindowState()
custom-window-state
elementsCustomWindowStateType
UserAttributeType<PortletDescriptor> getOrCreateUserAttribute()
user-attribute
element will be created and returned.
Otherwise, the first existing user-attribute
element will be returned.user-attribute
UserAttributeType<PortletDescriptor> createUserAttribute()
user-attribute
elementUserAttributeType
List<UserAttributeType<PortletDescriptor>> getAllUserAttribute()
user-attribute
elementsuser-attribute
PortletDescriptor removeAllUserAttribute()
user-attribute
elementsUserAttributeType
SecurityConstraintType<PortletDescriptor> getOrCreateSecurityConstraint()
security-constraint
element will be created and returned.
Otherwise, the first existing security-constraint
element will be returned.security-constraint
SecurityConstraintType<PortletDescriptor> createSecurityConstraint()
security-constraint
elementSecurityConstraintType
List<SecurityConstraintType<PortletDescriptor>> getAllSecurityConstraint()
security-constraint
elementssecurity-constraint
PortletDescriptor removeAllSecurityConstraint()
security-constraint
elementsSecurityConstraintType
PortletDescriptor resourceBundle(String resourceBundle)
resource-bundle
elementresourceBundle
- the value for the element resource-bundle
PortletDescriptor
String getResourceBundle()
resource-bundle
elementresource-bundle
PortletDescriptor removeResourceBundle()
resource-bundle
elementPortletDescriptor
FilterType<PortletDescriptor> getOrCreateFilter()
filter
element will be created and returned.
Otherwise, the first existing filter
element will be returned.filter
FilterType<PortletDescriptor> createFilter()
filter
elementFilterType
List<FilterType<PortletDescriptor>> getAllFilter()
filter
elementsfilter
PortletDescriptor removeAllFilter()
filter
elementsFilterType
FilterMappingType<PortletDescriptor> getOrCreateFilterMapping()
filter-mapping
element will be created and returned.
Otherwise, the first existing filter-mapping
element will be returned.filter-mapping
FilterMappingType<PortletDescriptor> createFilterMapping()
filter-mapping
elementFilterMappingType
List<FilterMappingType<PortletDescriptor>> getAllFilterMapping()
filter-mapping
elementsfilter-mapping
PortletDescriptor removeAllFilterMapping()
filter-mapping
elementsFilterMappingType
PortletDescriptor defaultNamespace(String defaultNamespace)
default-namespace
elementdefaultNamespace
- the value for the element default-namespace
PortletDescriptor
String getDefaultNamespace()
default-namespace
elementdefault-namespace
PortletDescriptor removeDefaultNamespace()
default-namespace
elementPortletDescriptor
EventDefinitionType<PortletDescriptor> getOrCreateEventDefinition()
event-definition
element will be created and returned.
Otherwise, the first existing event-definition
element will be returned.event-definition
EventDefinitionType<PortletDescriptor> createEventDefinition()
event-definition
elementEventDefinitionType
List<EventDefinitionType<PortletDescriptor>> getAllEventDefinition()
event-definition
elementsevent-definition
PortletDescriptor removeAllEventDefinition()
event-definition
elementsEventDefinitionType
PublicRenderParameterType<PortletDescriptor> getOrCreatePublicRenderParameter()
public-render-parameter
element will be created and returned.
Otherwise, the first existing public-render-parameter
element will be returned.public-render-parameter
PublicRenderParameterType<PortletDescriptor> createPublicRenderParameter()
public-render-parameter
elementPublicRenderParameterType
List<PublicRenderParameterType<PortletDescriptor>> getAllPublicRenderParameter()
public-render-parameter
elementspublic-render-parameter
PortletDescriptor removeAllPublicRenderParameter()
public-render-parameter
elementsPublicRenderParameterType
ListenerType<PortletDescriptor> getOrCreateListener()
listener
element will be created and returned.
Otherwise, the first existing listener
element will be returned.listener
ListenerType<PortletDescriptor> createListener()
listener
elementListenerType
List<ListenerType<PortletDescriptor>> getAllListener()
listener
elementslistener
PortletDescriptor removeAllListener()
listener
elementsListenerType
ContainerRuntimeOptionType<PortletDescriptor> getOrCreateContainerRuntimeOption()
container-runtime-option
element will be created and returned.
Otherwise, the first existing container-runtime-option
element will be returned.container-runtime-option
ContainerRuntimeOptionType<PortletDescriptor> createContainerRuntimeOption()
container-runtime-option
elementContainerRuntimeOptionType
List<ContainerRuntimeOptionType<PortletDescriptor>> getAllContainerRuntimeOption()
container-runtime-option
elementscontainer-runtime-option
PortletDescriptor removeAllContainerRuntimeOption()
container-runtime-option
elementsContainerRuntimeOptionType
PortletDescriptor version(String version)
version
attributeversion
in interface PortletCommonDescriptor<PortletDescriptor,PortletType<PortletDescriptor>,CustomPortletModeType<PortletDescriptor>,CustomWindowStateType<PortletDescriptor>,UserAttributeType<PortletDescriptor>,SecurityConstraintType<PortletDescriptor>,FilterType<PortletDescriptor>,FilterMappingType<PortletDescriptor>,EventDefinitionType<PortletDescriptor>,PublicRenderParameterType<PortletDescriptor>,ListenerType<PortletDescriptor>,ContainerRuntimeOptionType<PortletDescriptor>>
version
- the value for the attribute version
PortletDescriptor
String getVersion()
version
attributegetVersion
in interface PortletCommonDescriptor<PortletDescriptor,PortletType<PortletDescriptor>,CustomPortletModeType<PortletDescriptor>,CustomWindowStateType<PortletDescriptor>,UserAttributeType<PortletDescriptor>,SecurityConstraintType<PortletDescriptor>,FilterType<PortletDescriptor>,FilterMappingType<PortletDescriptor>,EventDefinitionType<PortletDescriptor>,PublicRenderParameterType<PortletDescriptor>,ListenerType<PortletDescriptor>,ContainerRuntimeOptionType<PortletDescriptor>>
version
PortletDescriptor removeVersion()
version
attributeremoveVersion
in interface PortletCommonDescriptor<PortletDescriptor,PortletType<PortletDescriptor>,CustomPortletModeType<PortletDescriptor>,CustomWindowStateType<PortletDescriptor>,UserAttributeType<PortletDescriptor>,SecurityConstraintType<PortletDescriptor>,FilterType<PortletDescriptor>,FilterMappingType<PortletDescriptor>,EventDefinitionType<PortletDescriptor>,PublicRenderParameterType<PortletDescriptor>,ListenerType<PortletDescriptor>,ContainerRuntimeOptionType<PortletDescriptor>>
PortletDescriptor
PortletDescriptor id(String id)
id
attributeid
in interface PortletCommonDescriptor<PortletDescriptor,PortletType<PortletDescriptor>,CustomPortletModeType<PortletDescriptor>,CustomWindowStateType<PortletDescriptor>,UserAttributeType<PortletDescriptor>,SecurityConstraintType<PortletDescriptor>,FilterType<PortletDescriptor>,FilterMappingType<PortletDescriptor>,EventDefinitionType<PortletDescriptor>,PublicRenderParameterType<PortletDescriptor>,ListenerType<PortletDescriptor>,ContainerRuntimeOptionType<PortletDescriptor>>
id
- the value for the attribute id
PortletDescriptor
String getId()
id
attributegetId
in interface PortletCommonDescriptor<PortletDescriptor,PortletType<PortletDescriptor>,CustomPortletModeType<PortletDescriptor>,CustomWindowStateType<PortletDescriptor>,UserAttributeType<PortletDescriptor>,SecurityConstraintType<PortletDescriptor>,FilterType<PortletDescriptor>,FilterMappingType<PortletDescriptor>,EventDefinitionType<PortletDescriptor>,PublicRenderParameterType<PortletDescriptor>,ListenerType<PortletDescriptor>,ContainerRuntimeOptionType<PortletDescriptor>>
id
PortletDescriptor removeId()
id
attributeremoveId
in interface PortletCommonDescriptor<PortletDescriptor,PortletType<PortletDescriptor>,CustomPortletModeType<PortletDescriptor>,CustomWindowStateType<PortletDescriptor>,UserAttributeType<PortletDescriptor>,SecurityConstraintType<PortletDescriptor>,FilterType<PortletDescriptor>,FilterMappingType<PortletDescriptor>,EventDefinitionType<PortletDescriptor>,PublicRenderParameterType<PortletDescriptor>,ListenerType<PortletDescriptor>,ContainerRuntimeOptionType<PortletDescriptor>>
PortletDescriptor
Copyright © 2017 JBoss by Red Hat. All rights reserved.