org.jboss.shrinkwrap.descriptor.api.facespartialresponse20
Interface WebFacesPartialResponseDescriptor

All Superinterfaces:

Descriptor, DescriptorNamespace<WebFacesPartialResponseDescriptor>

public interface WebFacesPartialResponseDescriptor
extends Descriptor, DescriptorNamespace<WebFacesPartialResponseDescriptor>

This deployment descriptor provides the functionalities as described in the specification

Example:

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

Since:

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

Author:

Ralf Battenfeld, Andrew Lee Rubinger

Method Summary

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	removeChanges() Removes the changes element
WebFacesPartialResponseDescriptor	removeError() Removes the error element
WebFacesPartialResponseDescriptor	removeRedirect() Removes the redirect element

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

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