org.jboss.shrinkwrap.descriptor.api.facesconfig20.FacesConfigRedirectType Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of shrinkwrap-descriptors-api-javaee Show documentation
Client View of the ShrinkWrap Descriptors Project
The newest version!
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.FacesConfigRedirectViewParamType;
import org.jboss.shrinkwrap.descriptor.api.facesconfig.*;
import org.jboss.shrinkwrap.descriptor.api.facesconfig.JavaeeFacesConfigRedirectCommonType;

import org.jboss.shrinkwrap.descriptor.api.facesconfig20.FacesConfigRedirectViewParamType;/**
 * This interface defines the contract for the  faces-config-redirectType  xsd type 
 * @author Ralf Battenfeld
 * @author Andrew Lee Rubinger
 * @author George Gastaldi
 */
public interface FacesConfigRedirectType extends Child, 
    JavaeeFacesConfigRedirectCommonType,
    FacesConfigRedirectViewParamType>> { 

 
   // --------------------------------------------------------------------------------------------------------||
   // ClassName: FacesConfigRedirectType ElementName: javaee:faces-config-redirect-viewParamType ElementType : view-param
   // MaxOccurs: -unbounded  isGeneric: true   isAttribute: false isEnum: false isDataType: false
   // --------------------------------------------------------------------------------------------------------||

   /**
    * If not already created, a new view-param element will be created and returned.
    * Otherwise, the first existing view-param element will be returned.
    * @return the instance defined for the element view-param 
    */
   public FacesConfigRedirectViewParamType> getOrCreateViewParam();

   /**
    * Creates a new view-param element 
    * @return the new created instance of FacesConfigRedirectViewParamType> 
    */
   public FacesConfigRedirectViewParamType> createViewParam();

   /**
    * Returns all view-param elements
    * @return list of view-param 
    */
   public List>> getAllViewParam();

   /**
    * Removes all view-param elements 
    * @return the current instance of FacesConfigRedirectViewParamType> 
    */
   public FacesConfigRedirectType removeAllViewParam();

 
   // --------------------------------------------------------------------------------------------------------||
   // ClassName: FacesConfigRedirectType 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 FacesConfigRedirectType 
    */
   public FacesConfigRedirectType 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 FacesConfigRedirectType 
    */
   public FacesConfigRedirectType removeId();

 
   // --------------------------------------------------------------------------------------------------------||
   // ClassName: FacesConfigRedirectType ElementName: xsd:boolean ElementType : include-view-params
   // MaxOccurs: -  isGeneric: true   isAttribute: true isEnum: false isDataType: true
   // --------------------------------------------------------------------------------------------------------||

   /**
    * Sets the include-view-params attribute
    * @param includeViewParams the value for the attribute include-view-params 
    * @return the current instance of FacesConfigRedirectType 
    */
   public FacesConfigRedirectType includeViewParams(Boolean includeViewParams);

   /**
    * Returns the include-view-params attribute
    * @return the value defined for the attribute include-view-params 
    */
public Boolean isIncludeViewParams();

   /**
    * Removes the include-view-params attribute 
    * @return the current instance of FacesConfigRedirectType 
    */
   public FacesConfigRedirectType removeIncludeViewParams();
}