org.jboss.shrinkwrap.descriptor.api.facesconfig20.FacesConfigComponentType 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.FacesConfigFacetType;
import org.jboss.shrinkwrap.descriptor.api.facesconfig20.FacesConfigAttributeType;
import org.jboss.shrinkwrap.descriptor.api.facesconfig20.FacesConfigPropertyType;
import org.jboss.shrinkwrap.descriptor.api.javaee5.IconType;
import org.jboss.shrinkwrap.descriptor.api.facesconfig.*;
import org.jboss.shrinkwrap.descriptor.api.facesconfig.JavaeeFacesConfigComponentCommonType;

import org.jboss.shrinkwrap.descriptor.api.facesconfig20.FacesConfigFacetType;
import org.jboss.shrinkwrap.descriptor.api.facesconfig20.FacesConfigAttributeType;
import org.jboss.shrinkwrap.descriptor.api.facesconfig20.FacesConfigPropertyType;/**
 * This interface defines the contract for the  faces-config-componentType  xsd type 
 * @author Ralf Battenfeld
 * @author Andrew Lee Rubinger
 * @author George Gastaldi
 */
public interface FacesConfigComponentType extends Child, 
    JavaeeFacesConfigComponentCommonType,
    FacesConfigFacetType>,
    FacesConfigAttributeType>,
    FacesConfigPropertyType>> { 

 
   // --------------------------------------------------------------------------------------------------------||
   // ClassName: FacesConfigComponentType 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 FacesConfigComponentType 
    */
   public FacesConfigComponentType description(String ... values);

   /**
    * Returns all description elements
    * @return list of description 
    */
   public List getAllDescription();

   /**
    * Removes the description element 
    * @return the current instance of FacesConfigComponentType 
    */
   public FacesConfigComponentType removeAllDescription();
 
   // --------------------------------------------------------------------------------------------------------||
   // ClassName: FacesConfigComponentType 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 FacesConfigComponentType 
    */
   public FacesConfigComponentType 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 FacesConfigComponentType 
    */
   public FacesConfigComponentType removeAllDisplayName();
 
   // --------------------------------------------------------------------------------------------------------||
   // ClassName: FacesConfigComponentType 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 FacesConfigComponentType removeAllIcon();
 
   // --------------------------------------------------------------------------------------------------------||
   // ClassName: FacesConfigComponentType ElementName: xsd:token ElementType : component-type
   // MaxOccurs: -  isGeneric: true   isAttribute: false isEnum: false isDataType: true
   // --------------------------------------------------------------------------------------------------------||

   /**
    * Sets the component-type element
    * @param componentType the value for the element component-type 
    * @return the current instance of FacesConfigComponentType 
    */
   public FacesConfigComponentType componentType(String componentType);

   /**
    * Returns the component-type element
    * @return the node defined for the element component-type 
    */
   public String getComponentType();

   /**
    * Removes the component-type element 
    * @return the current instance of FacesConfigComponentType 
    */
   public FacesConfigComponentType removeComponentType();

 
   // --------------------------------------------------------------------------------------------------------||
   // ClassName: FacesConfigComponentType ElementName: xsd:token ElementType : component-class
   // MaxOccurs: -  isGeneric: true   isAttribute: false isEnum: false isDataType: true
   // --------------------------------------------------------------------------------------------------------||

   /**
    * Sets the component-class element
    * @param componentClass the value for the element component-class 
    * @return the current instance of FacesConfigComponentType 
    */
   public FacesConfigComponentType componentClass(String componentClass);

   /**
    * Returns the component-class element
    * @return the node defined for the element component-class 
    */
   public String getComponentClass();

   /**
    * Removes the component-class element 
    * @return the current instance of FacesConfigComponentType 
    */
   public FacesConfigComponentType removeComponentClass();

 
   // --------------------------------------------------------------------------------------------------------||
   // ClassName: FacesConfigComponentType ElementName: javaee:faces-config-facetType ElementType : facet
   // MaxOccurs: -unbounded  isGeneric: true   isAttribute: false isEnum: false isDataType: false
   // --------------------------------------------------------------------------------------------------------||

   /**
    * If not already created, a new facet element will be created and returned.
    * Otherwise, the first existing facet element will be returned.
    * @return the instance defined for the element facet 
    */
   public FacesConfigFacetType> getOrCreateFacet();

   /**
    * Creates a new facet element 
    * @return the new created instance of FacesConfigFacetType> 
    */
   public FacesConfigFacetType> createFacet();

   /**
    * Returns all facet elements
    * @return list of facet 
    */
   public List>> getAllFacet();

   /**
    * Removes all facet elements 
    * @return the current instance of FacesConfigFacetType> 
    */
   public FacesConfigComponentType removeAllFacet();

 
   // --------------------------------------------------------------------------------------------------------||
   // ClassName: FacesConfigComponentType ElementName: javaee:faces-config-attributeType ElementType : attribute
   // MaxOccurs: -unbounded  isGeneric: true   isAttribute: false isEnum: false isDataType: false
   // --------------------------------------------------------------------------------------------------------||

   /**
    * If not already created, a new attribute element will be created and returned.
    * Otherwise, the first existing attribute element will be returned.
    * @return the instance defined for the element attribute 
    */
   public FacesConfigAttributeType> getOrCreateAttribute();

   /**
    * Creates a new attribute element 
    * @return the new created instance of FacesConfigAttributeType> 
    */
   public FacesConfigAttributeType> createAttribute();

   /**
    * Returns all attribute elements
    * @return list of attribute 
    */
   public List>> getAllAttribute();

   /**
    * Removes all attribute elements 
    * @return the current instance of FacesConfigAttributeType> 
    */
   public FacesConfigComponentType removeAllAttribute();

 
   // --------------------------------------------------------------------------------------------------------||
   // ClassName: FacesConfigComponentType ElementName: javaee:faces-config-propertyType ElementType : property
   // MaxOccurs: -unbounded  isGeneric: true   isAttribute: false isEnum: false isDataType: false
   // --------------------------------------------------------------------------------------------------------||

   /**
    * If not already created, a new property element will be created and returned.
    * Otherwise, the first existing property element will be returned.
    * @return the instance defined for the element property 
    */
   public FacesConfigPropertyType> getOrCreateProperty();

   /**
    * Creates a new property element 
    * @return the new created instance of FacesConfigPropertyType> 
    */
   public FacesConfigPropertyType> createProperty();

   /**
    * Returns all property elements
    * @return list of property 
    */
   public List>> getAllProperty();

   /**
    * Removes all property elements 
    * @return the current instance of FacesConfigPropertyType> 
    */
   public FacesConfigComponentType removeAllProperty();

 
   // --------------------------------------------------------------------------------------------------------||
   // ClassName: FacesConfigComponentType ElementName: javaee:faces-config-component-extensionType ElementType : component-extension
   // MaxOccurs: -unbounded  isGeneric: true   isAttribute: false isEnum: false isDataType: false
   // --------------------------------------------------------------------------------------------------------||

   /**
    * Sets the component-extension element 
    * @return the current instance of FacesConfigComponentType 
    */
   public FacesConfigComponentType componentExtension();

   /**
    * Removes the component-extension element 
    * @return the current instance of FacesConfigComponentType 
    */
   public Boolean isComponentExtension();

   /**
    * Removes the component-extension element 
    * @return the current instance of FacesConfigComponentType 
    */
   public FacesConfigComponentType removeComponentExtension();

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