org.jboss.shrinkwrap.descriptor.api.facespartialresponse22

Interface WebFacesPartialResponseDescriptor

All Superinterfaces:

Descriptor, DescriptorNamespace<WebFacesPartialResponseDescriptor>, WebFacesPartialResponseCommonDescriptor<WebFacesPartialResponseDescriptor,PartialResponseChangesType<WebFacesPartialResponseDescriptor>,PartialResponseRedirectType<WebFacesPartialResponseDescriptor>,PartialResponseErrorType<WebFacesPartialResponseDescriptor>>

public interface WebFacesPartialResponseDescriptor
extends Descriptor, DescriptorNamespace<WebFacesPartialResponseDescriptor>, WebFacesPartialResponseCommonDescriptor<WebFacesPartialResponseDescriptor,PartialResponseChangesType<WebFacesPartialResponseDescriptor>,PartialResponseRedirectType<WebFacesPartialResponseDescriptor>,PartialResponseErrorType<WebFacesPartialResponseDescriptor>>

This deployment descriptor provides the functionalities as described in the specification

Example:

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

Author:

Ralf Battenfeld, Andrew Lee Rubinger

Method Summary

Modifier and Type	Method and Description
String	getId() Returns the id attribute
PartialResponseChangesType<WebFacesPartialResponseDescriptor>	getOrCreateChanges() If not already created, a new changes element with the given value will be created.
PartialResponseErrorType<WebFacesPartialResponseDescriptor>	getOrCreateError() If not already created, a new error element with the given value will be created.
PartialResponseRedirectType<WebFacesPartialResponseDescriptor>	getOrCreateRedirect() If not already created, a new redirect element with the given value will be created.
WebFacesPartialResponseDescriptor	id(String id) Sets the id attribute
WebFacesPartialResponseDescriptor	removeChanges() Removes the changes element
WebFacesPartialResponseDescriptor	removeError() Removes the error element
WebFacesPartialResponseDescriptor	removeId() Removes the id attribute
WebFacesPartialResponseDescriptor	removeRedirect() Removes the redirect element

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

addDefaultNamespaces, addNamespace, getNamespaces, removeAllNamespaces

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

exportAsString, exportTo, getDescriptorName

Method Detail

getOrCreateChanges

PartialResponseChangesType<WebFacesPartialResponseDescriptor> getOrCreateChanges()

If not already created, a new changes element with the given value will be created. Otherwise, the existing changes element will be returned.

Returns:

a new or existing instance of PartialResponseChangesType

removeChanges

WebFacesPartialResponseDescriptor removeChanges()

Removes the changes element

Returns:

the current instance of WebFacesPartialResponseDescriptor

getOrCreateRedirect

PartialResponseRedirectType<WebFacesPartialResponseDescriptor> getOrCreateRedirect()

If not already created, a new redirect element with the given value will be created. Otherwise, the existing redirect element will be returned.

Returns:

a new or existing instance of PartialResponseRedirectType

removeRedirect

WebFacesPartialResponseDescriptor removeRedirect()

Removes the redirect element

Returns:

the current instance of WebFacesPartialResponseDescriptor

getOrCreateError

PartialResponseErrorType<WebFacesPartialResponseDescriptor> getOrCreateError()

If not already created, a new error element with the given value will be created. Otherwise, the existing error element will be returned.

Returns:

a new or existing instance of PartialResponseErrorType

removeError

WebFacesPartialResponseDescriptor removeError()

Removes the error element

Returns:

the current instance of WebFacesPartialResponseDescriptor

id

WebFacesPartialResponseDescriptor id(String id)

Sets the id attribute

Parameters:

id - the value for the attribute id

Returns:

the current instance of WebFacesPartialResponseDescriptor

getId

String getId()

Returns the id attribute

Returns:

the value defined for the attribute id

removeId

WebFacesPartialResponseDescriptor removeId()

Removes the id attribute

Returns:

the current instance of WebFacesPartialResponseDescriptor