org.jboss.shrinkwrap.descriptor.api.facesconfig20.FacesConfigNavigationCaseType Maven / Gradle / Ivy
package org.jboss.shrinkwrap.descriptor.api.facesconfig20;
import java.util.ArrayList;
import java.util.List;
import org.jboss.shrinkwrap.descriptor.api.Child;
import org.jboss.shrinkwrap.descriptor.api.facesconfig20.FacesConfigRedirectType;
import org.jboss.shrinkwrap.descriptor.api.javaee5.IconType;
import org.jboss.shrinkwrap.descriptor.api.facesconfig.*;
import org.jboss.shrinkwrap.descriptor.api.facesconfig.JavaeeFacesConfigNavigationCaseCommonType;
import org.jboss.shrinkwrap.descriptor.api.facesconfig20.FacesConfigRedirectType;/**
* This interface defines the contract for the faces-config-navigation-caseType xsd type
* @author Ralf Battenfeld
* @author Andrew Lee Rubinger
* @author George Gastaldi
*/
public interface FacesConfigNavigationCaseType extends Child,
JavaeeFacesConfigNavigationCaseCommonType,
FacesConfigRedirectType>> {
// --------------------------------------------------------------------------------------------------------||
// ClassName: FacesConfigNavigationCaseType 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 FacesConfigNavigationCaseType
*/
public FacesConfigNavigationCaseType description(String ... values);
/**
* Returns all description elements
* @return list of description
*/
public List getAllDescription();
/**
* Removes the description element
* @return the current instance of FacesConfigNavigationCaseType
*/
public FacesConfigNavigationCaseType removeAllDescription();
// --------------------------------------------------------------------------------------------------------||
// ClassName: FacesConfigNavigationCaseType 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 FacesConfigNavigationCaseType
*/
public FacesConfigNavigationCaseType 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 FacesConfigNavigationCaseType
*/
public FacesConfigNavigationCaseType removeAllDisplayName();
// --------------------------------------------------------------------------------------------------------||
// ClassName: FacesConfigNavigationCaseType 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 FacesConfigNavigationCaseType removeAllIcon();
// --------------------------------------------------------------------------------------------------------||
// ClassName: FacesConfigNavigationCaseType ElementName: javaee:faces-config-el-expressionType ElementType : from-action
// MaxOccurs: - isGeneric: true isAttribute: false isEnum: false isDataType: true
// --------------------------------------------------------------------------------------------------------||
/**
* Sets the from-action element
* @param fromAction the value for the element from-action
* @return the current instance of FacesConfigNavigationCaseType
*/
public FacesConfigNavigationCaseType fromAction(String fromAction);
/**
* Returns the from-action element
* @return the node defined for the element from-action
*/
public String getFromAction();
/**
* Removes the from-action element
* @return the current instance of FacesConfigNavigationCaseType
*/
public FacesConfigNavigationCaseType removeFromAction();
// --------------------------------------------------------------------------------------------------------||
// ClassName: FacesConfigNavigationCaseType ElementName: xsd:token ElementType : from-outcome
// MaxOccurs: - isGeneric: true isAttribute: false isEnum: false isDataType: true
// --------------------------------------------------------------------------------------------------------||
/**
* Sets the from-outcome element
* @param fromOutcome the value for the element from-outcome
* @return the current instance of FacesConfigNavigationCaseType
*/
public FacesConfigNavigationCaseType fromOutcome(String fromOutcome);
/**
* Returns the from-outcome element
* @return the node defined for the element from-outcome
*/
public String getFromOutcome();
/**
* Removes the from-outcome element
* @return the current instance of FacesConfigNavigationCaseType
*/
public FacesConfigNavigationCaseType removeFromOutcome();
// --------------------------------------------------------------------------------------------------------||
// ClassName: FacesConfigNavigationCaseType ElementName: javaee:faces-config-el-expressionType ElementType : if
// MaxOccurs: - isGeneric: true isAttribute: false isEnum: false isDataType: true
// --------------------------------------------------------------------------------------------------------||
/**
* Sets the if element
* @param _if the value for the element if
* @return the current instance of FacesConfigNavigationCaseType
*/
public FacesConfigNavigationCaseType _if(String _if);
/**
* Returns the if element
* @return the node defined for the element if
*/
public String getIf();
/**
* Removes the if element
* @return the current instance of FacesConfigNavigationCaseType
*/
public FacesConfigNavigationCaseType removeIf();
// --------------------------------------------------------------------------------------------------------||
// ClassName: FacesConfigNavigationCaseType ElementName: javaee:faces-config-el-expressionType ElementType : to-view-id
// MaxOccurs: - isGeneric: true isAttribute: false isEnum: false isDataType: true
// --------------------------------------------------------------------------------------------------------||
/**
* Sets the to-view-id element
* @param toViewId the value for the element to-view-id
* @return the current instance of FacesConfigNavigationCaseType
*/
public FacesConfigNavigationCaseType toViewId(String toViewId);
/**
* Returns the to-view-id element
* @return the node defined for the element to-view-id
*/
public String getToViewId();
/**
* Removes the to-view-id element
* @return the current instance of FacesConfigNavigationCaseType
*/
public FacesConfigNavigationCaseType removeToViewId();
// --------------------------------------------------------------------------------------------------------||
// ClassName: FacesConfigNavigationCaseType ElementName: javaee:faces-config-redirectType ElementType : redirect
// MaxOccurs: - isGeneric: true isAttribute: false isEnum: false isDataType: false
// --------------------------------------------------------------------------------------------------------||
/**
* If not already created, a new redirect element with the given value will be created.
* Otherwise, the existing redirect element will be returned.
* @return a new or existing instance of FacesConfigRedirectType>
*/
public FacesConfigRedirectType> getOrCreateRedirect();
/**
* Removes the redirect element
* @return the current instance of FacesConfigNavigationCaseType
*/
public FacesConfigNavigationCaseType removeRedirect();
// --------------------------------------------------------------------------------------------------------||
// ClassName: FacesConfigNavigationCaseType 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 FacesConfigNavigationCaseType
*/
public FacesConfigNavigationCaseType 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 FacesConfigNavigationCaseType
*/
public FacesConfigNavigationCaseType removeId();
}