org.jboss.shrinkwrap.descriptor.api.facesconfig21

Interface FacesConfigRedirectType<T>

All Superinterfaces:

Child<T>, JavaeeFacesConfigRedirectCommonType<T,FacesConfigRedirectType<T>,FacesConfigRedirectViewParamType<FacesConfigRedirectType<T>>>

public interface FacesConfigRedirectType<T>
extends Child<T>, JavaeeFacesConfigRedirectCommonType<T,FacesConfigRedirectType<T>,FacesConfigRedirectViewParamType<FacesConfigRedirectType<T>>>

This interface defines the contract for the faces-config-redirectType xsd type

Author:

Ralf Battenfeld, Andrew Lee Rubinger, George Gastaldi

Method Summary

Modifier and Type	Method and Description
FacesConfigRedirectRedirectParamType<FacesConfigRedirectType<T>>	createRedirectParam() Creates a new redirect-param element
FacesConfigRedirectViewParamType<FacesConfigRedirectType<T>>	createViewParam() Creates a new view-param element
List<FacesConfigRedirectRedirectParamType<FacesConfigRedirectType<T>>>	getAllRedirectParam() Returns all redirect-param elements
List<FacesConfigRedirectViewParamType<FacesConfigRedirectType<T>>>	getAllViewParam() Returns all view-param elements
String	getId() Returns the id attribute
FacesConfigRedirectRedirectParamType<FacesConfigRedirectType<T>>	getOrCreateRedirectParam() If not already created, a new redirect-param element will be created and returned.
FacesConfigRedirectViewParamType<FacesConfigRedirectType<T>>	getOrCreateViewParam() If not already created, a new view-param element will be created and returned.
FacesConfigRedirectType<T>	id(String id) Sets the id attribute
FacesConfigRedirectType<T>	includeViewParams(Boolean includeViewParams) Sets the include-view-params attribute
Boolean	isIncludeViewParams() Returns the include-view-params attribute
FacesConfigRedirectType<T>	removeAllRedirectParam() Removes all redirect-param elements
FacesConfigRedirectType<T>	removeAllViewParam() Removes all view-param elements
FacesConfigRedirectType<T>	removeId() Removes the id attribute
FacesConfigRedirectType<T>	removeIncludeViewParams() Removes the include-view-params attribute

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

up

Method Detail

getOrCreateViewParam

FacesConfigRedirectViewParamType<FacesConfigRedirectType<T>> getOrCreateViewParam()

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

Returns:

the instance defined for the element view-param

createViewParam

FacesConfigRedirectViewParamType<FacesConfigRedirectType<T>> createViewParam()

Creates a new view-param element

Returns:

the new created instance of FacesConfigRedirectViewParamType>

getAllViewParam

List<FacesConfigRedirectViewParamType<FacesConfigRedirectType<T>>> getAllViewParam()

Returns all view-param elements

Returns:

list of view-param

removeAllViewParam

FacesConfigRedirectType<T> removeAllViewParam()

Removes all view-param elements

Returns:

the current instance of FacesConfigRedirectViewParamType>

getOrCreateRedirectParam

FacesConfigRedirectRedirectParamType<FacesConfigRedirectType<T>> getOrCreateRedirectParam()

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

Returns:

the instance defined for the element redirect-param

createRedirectParam

FacesConfigRedirectRedirectParamType<FacesConfigRedirectType<T>> createRedirectParam()

Creates a new redirect-param element

Returns:

the new created instance of FacesConfigRedirectRedirectParamType>

getAllRedirectParam

List<FacesConfigRedirectRedirectParamType<FacesConfigRedirectType<T>>> getAllRedirectParam()

Returns all redirect-param elements

Returns:

list of redirect-param

removeAllRedirectParam

FacesConfigRedirectType<T> removeAllRedirectParam()

Removes all redirect-param elements

Returns:

the current instance of FacesConfigRedirectRedirectParamType>

id

FacesConfigRedirectType<T> id(String id)

Sets the id attribute

Parameters:

id - the value for the attribute id

Returns:

the current instance of FacesConfigRedirectType

getId

String getId()

Returns the id attribute

Returns:

the value defined for the attribute id

removeId

FacesConfigRedirectType<T> removeId()

Removes the id attribute

Returns:

the current instance of FacesConfigRedirectType

includeViewParams

FacesConfigRedirectType<T> includeViewParams(Boolean includeViewParams)

Sets the include-view-params attribute

Parameters:

includeViewParams - the value for the attribute include-view-params

Returns:

the current instance of FacesConfigRedirectType

isIncludeViewParams

Boolean isIncludeViewParams()

Returns the include-view-params attribute

Returns:

the value defined for the attribute include-view-params

removeIncludeViewParams

FacesConfigRedirectType<T> removeIncludeViewParams()

Removes the include-view-params attribute

Returns:

the current instance of FacesConfigRedirectType