org.jboss.shrinkwrap.descriptor.api.facesconfig20
Interface FacesConfigNavigationRuleType<T>

All Superinterfaces:

Child<T>

public interface FacesConfigNavigationRuleType<T>
extends Child<T>

This interface defines the contract for the faces-config-navigation-ruleType xsd type

Since:

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

Author:

Ralf Battenfeld, Andrew Lee Rubinger

Method Summary

IconType<FacesConfigNavigationRuleType<T>>	createIcon() Creates a new icon element
FacesConfigNavigationCaseType<FacesConfigNavigationRuleType<T>>	createNavigationCase() Creates a new navigation-case element
FacesConfigNavigationRuleType<T>	description(String... values) Creates for all String objects representing description elements, a new description element
FacesConfigNavigationRuleType<T>	displayName(String... values) Creates for all String objects representing display-name elements, a new display-name element
FacesConfigNavigationRuleType<T>	fromViewId(String fromViewId) Sets the from-view-id element
List<String>	getAllDescription() Returns all description elements
List<String>	getAllDisplayName() Returns all display-name elements
List<IconType<FacesConfigNavigationRuleType<T>>>	getAllIcon() Returns all icon elements
List<FacesConfigNavigationCaseType<FacesConfigNavigationRuleType<T>>>	getAllNavigationCase() Returns all navigation-case elements
String	getFromViewId() Returns the from-view-id element
IconType<FacesConfigNavigationRuleType<T>>	getOrCreateIcon() If not already created, a new icon element will be created and returned.
FacesConfigNavigationCaseType<FacesConfigNavigationRuleType<T>>	getOrCreateNavigationCase() If not already created, a new navigation-case element will be created and returned.
Boolean	isNavigationRuleExtension() Removes the navigation-rule-extension element
FacesConfigNavigationRuleType<T>	navigationRuleExtension() Sets the navigation-rule-extension element
FacesConfigNavigationRuleType<T>	removeAllDescription() Removes the description element
FacesConfigNavigationRuleType<T>	removeAllDisplayName() Removes the display-name element
FacesConfigNavigationRuleType<T>	removeAllIcon() Removes all icon elements
FacesConfigNavigationRuleType<T>	removeAllNavigationCase() Removes all navigation-case elements
FacesConfigNavigationRuleType<T>	removeFromViewId() Removes the from-view-id element
FacesConfigNavigationRuleType<T>	removeNavigationRuleExtension() Removes the navigation-rule-extension element

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

up

Method Detail

description

FacesConfigNavigationRuleType<T> description(String... values)

Creates for all String objects representing description elements, a new description element

Parameters:

values - list of description objects

Returns:

the current instance of FacesConfigNavigationRuleType

getAllDescription

List<String> getAllDescription()

Returns all description elements

Returns:

list of description

removeAllDescription

FacesConfigNavigationRuleType<T> removeAllDescription()

Removes the description element

Returns:

the current instance of FacesConfigNavigationRuleType

displayName

FacesConfigNavigationRuleType<T> displayName(String... values)

Creates for all String objects representing display-name elements, a new display-name element

Parameters:

values - list of display-name objects

Returns:

the current instance of FacesConfigNavigationRuleType

getAllDisplayName

List<String> getAllDisplayName()

Returns all display-name elements

Returns:

list of display-name

removeAllDisplayName

FacesConfigNavigationRuleType<T> removeAllDisplayName()

Removes the display-name element

Returns:

the current instance of FacesConfigNavigationRuleType

getOrCreateIcon

IconType<FacesConfigNavigationRuleType<T>> getOrCreateIcon()

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

Returns:

the instance defined for the element icon

createIcon

IconType<FacesConfigNavigationRuleType<T>> createIcon()

Creates a new icon element

Returns:

the new created instance of IconType>

getAllIcon

List<IconType<FacesConfigNavigationRuleType<T>>> getAllIcon()

Returns all icon elements

Returns:

list of icon

removeAllIcon

FacesConfigNavigationRuleType<T> removeAllIcon()

Removes all icon elements

Returns:

the current instance of IconType>

fromViewId

FacesConfigNavigationRuleType<T> fromViewId(String fromViewId)

Sets the from-view-id element

Parameters:

fromViewId - the value for the element from-view-id

Returns:

the current instance of FacesConfigNavigationRuleType

getFromViewId

String getFromViewId()

Returns the from-view-id element

Returns:

the node defined for the element from-view-id

removeFromViewId

FacesConfigNavigationRuleType<T> removeFromViewId()

Removes the from-view-id element

Returns:

the current instance of FacesConfigNavigationRuleType

getOrCreateNavigationCase

FacesConfigNavigationCaseType<FacesConfigNavigationRuleType<T>> getOrCreateNavigationCase()

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

Returns:

the instance defined for the element navigation-case

createNavigationCase

FacesConfigNavigationCaseType<FacesConfigNavigationRuleType<T>> createNavigationCase()

Creates a new navigation-case element

Returns:

the new created instance of FacesConfigNavigationCaseType>

getAllNavigationCase

List<FacesConfigNavigationCaseType<FacesConfigNavigationRuleType<T>>> getAllNavigationCase()

Returns all navigation-case elements

Returns:

list of navigation-case

removeAllNavigationCase

FacesConfigNavigationRuleType<T> removeAllNavigationCase()

Removes all navigation-case elements

Returns:

the current instance of FacesConfigNavigationCaseType>

navigationRuleExtension

FacesConfigNavigationRuleType<T> navigationRuleExtension()

Sets the navigation-rule-extension element

Returns:

the current instance of FacesConfigNavigationRuleType

isNavigationRuleExtension

Boolean isNavigationRuleExtension()

Removes the navigation-rule-extension element

Returns:

the current instance of FacesConfigNavigationRuleType

removeNavigationRuleExtension

FacesConfigNavigationRuleType<T> removeNavigationRuleExtension()

Removes the navigation-rule-extension element

Returns:

the current instance of FacesConfigNavigationRuleType