org.jboss.shrinkwrap.descriptor.api.facesconfig22.FacesConfigNavigationRuleType Maven / Gradle / Ivy
package org.jboss.shrinkwrap.descriptor.api.facesconfig22;
import java.util.ArrayList;
import java.util.List;
import org.jboss.shrinkwrap.descriptor.api.Child;
import org.jboss.shrinkwrap.descriptor.api.facesconfig22.FacesConfigNavigationCaseType;
import org.jboss.shrinkwrap.descriptor.api.javaee7.IconType;
import org.jboss.shrinkwrap.descriptor.api.facesconfig.*;
import org.jboss.shrinkwrap.descriptor.api.facesconfig.JavaeeFacesConfigNavigationRuleCommonType;
import org.jboss.shrinkwrap.descriptor.api.facesconfig22.FacesConfigNavigationCaseType;/**
* This interface defines the contract for the faces-config-navigation-ruleType xsd type
* @author Ralf Battenfeld
* @author Andrew Lee Rubinger
*/
public interface FacesConfigNavigationRuleType extends Child,
JavaeeFacesConfigNavigationRuleCommonType,
FacesConfigNavigationCaseType>> {
// --------------------------------------------------------------------------------------------------------||
// ClassName: FacesConfigNavigationRuleType ElementName: xsd:string ElementType : description
// MaxOccurs: -unbounded isGeneric: true isAttribute: false isEnum: false isDataType: true
// --------------------------------------------------------------------------------------------------------||
/**
* Creates for all String objects representing description elements,
* a new description element
* @param values list of description objects
* @return the current instance of FacesConfigNavigationRuleType
*/
public FacesConfigNavigationRuleType description(String ... values);
/**
* Returns all description elements
* @return list of description
*/
public List getAllDescription();
/**
* Removes the description element
* @return the current instance of FacesConfigNavigationRuleType
*/
public FacesConfigNavigationRuleType removeAllDescription();
// --------------------------------------------------------------------------------------------------------||
// ClassName: FacesConfigNavigationRuleType ElementName: xsd:token ElementType : display-name
// MaxOccurs: -unbounded isGeneric: true isAttribute: false isEnum: false isDataType: true
// --------------------------------------------------------------------------------------------------------||
/**
* Creates for all String objects representing display-name elements,
* a new display-name element
* @param values list of display-name objects
* @return the current instance of FacesConfigNavigationRuleType
*/
public FacesConfigNavigationRuleType displayName(String ... values);
/**
* Returns all display-name elements
* @return list of display-name
*/
public List getAllDisplayName();
/**
* Removes the display-name element
* @return the current instance of FacesConfigNavigationRuleType
*/
public FacesConfigNavigationRuleType removeAllDisplayName();
// --------------------------------------------------------------------------------------------------------||
// ClassName: FacesConfigNavigationRuleType ElementName: javaee:iconType ElementType : icon
// MaxOccurs: -unbounded isGeneric: true isAttribute: false isEnum: false isDataType: false
// --------------------------------------------------------------------------------------------------------||
/**
* If not already created, a new icon element will be created and returned.
* Otherwise, the first existing icon element will be returned.
* @return the instance defined for the element icon
*/
public IconType> getOrCreateIcon();
/**
* Creates a new icon element
* @return the new created instance of IconType>
*/
public IconType> createIcon();
/**
* Returns all icon elements
* @return list of icon
*/
public List>> getAllIcon();
/**
* Removes all icon elements
* @return the current instance of IconType>
*/
public FacesConfigNavigationRuleType removeAllIcon();
// --------------------------------------------------------------------------------------------------------||
// ClassName: FacesConfigNavigationRuleType ElementName: javaee:string ElementType : from-view-id
// MaxOccurs: - isGeneric: true isAttribute: false isEnum: false isDataType: true
// --------------------------------------------------------------------------------------------------------||
/**
* Sets the from-view-id element
* @param fromViewId the value for the element from-view-id
* @return the current instance of FacesConfigNavigationRuleType
*/
public FacesConfigNavigationRuleType fromViewId(String fromViewId);
/**
* Returns the from-view-id element
* @return the node defined for the element from-view-id
*/
public String getFromViewId();
/**
* Removes the from-view-id element
* @return the current instance of FacesConfigNavigationRuleType
*/
public FacesConfigNavigationRuleType removeFromViewId();
// --------------------------------------------------------------------------------------------------------||
// ClassName: FacesConfigNavigationRuleType ElementName: javaee:faces-config-navigation-caseType ElementType : navigation-case
// MaxOccurs: -unbounded isGeneric: true isAttribute: false isEnum: false isDataType: false
// --------------------------------------------------------------------------------------------------------||
/**
* If not already created, a new navigation-case element will be created and returned.
* Otherwise, the first existing navigation-case element will be returned.
* @return the instance defined for the element navigation-case
*/
public FacesConfigNavigationCaseType> getOrCreateNavigationCase();
/**
* Creates a new navigation-case element
* @return the new created instance of FacesConfigNavigationCaseType>
*/
public FacesConfigNavigationCaseType> createNavigationCase();
/**
* Returns all navigation-case elements
* @return list of navigation-case
*/
public List>> getAllNavigationCase();
/**
* Removes all navigation-case elements
* @return the current instance of FacesConfigNavigationCaseType>
*/
public FacesConfigNavigationRuleType removeAllNavigationCase();
// --------------------------------------------------------------------------------------------------------||
// ClassName: FacesConfigNavigationRuleType ElementName: javaee:faces-config-navigation-rule-extensionType ElementType : navigation-rule-extension
// MaxOccurs: -unbounded isGeneric: true isAttribute: false isEnum: false isDataType: false
// --------------------------------------------------------------------------------------------------------||
/**
* Sets the navigation-rule-extension element
* @return the current instance of FacesConfigNavigationRuleType
*/
public FacesConfigNavigationRuleType navigationRuleExtension();
/**
* Removes the navigation-rule-extension element
* @return the current instance of FacesConfigNavigationRuleType
*/
public Boolean isNavigationRuleExtension();
/**
* Removes the navigation-rule-extension element
* @return the current instance of FacesConfigNavigationRuleType
*/
public FacesConfigNavigationRuleType removeNavigationRuleExtension();
// --------------------------------------------------------------------------------------------------------||
// ClassName: FacesConfigNavigationRuleType ElementName: xsd:ID ElementType : id
// MaxOccurs: - isGeneric: true isAttribute: true isEnum: false isDataType: true
// --------------------------------------------------------------------------------------------------------||
/**
* Sets the id attribute
* @param id the value for the attribute id
* @return the current instance of FacesConfigNavigationRuleType
*/
public FacesConfigNavigationRuleType id(String id);
/**
* Returns the id attribute
* @return the value defined for the attribute id
*/
public String getId();
/**
* Removes the id attribute
* @return the current instance of FacesConfigNavigationRuleType
*/
public FacesConfigNavigationRuleType removeId();
}