org.jboss.shrinkwrap.descriptor.api.facesconfig20.FacesConfigAttributeType 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.javaee5.IconType;
import org.jboss.shrinkwrap.descriptor.api.facesconfig.*;
/**
 * This interface defines the contract for the  faces-config-attributeType  xsd type 
 * @author Ralf Battenfeld
 * @author Andrew Lee Rubinger
 * @author George Gastaldi
 */
public interface FacesConfigAttributeType extends Child, 
    JavaeeFacesConfigAttributeCommonType> { 

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

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

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

   /**
    * Sets the attribute-name element
    * @param attributeName the value for the element attribute-name 
    * @return the current instance of FacesConfigAttributeType 
    */
   public FacesConfigAttributeType attributeName(String attributeName);

   /**
    * Returns the attribute-name element
    * @return the node defined for the element attribute-name 
    */
   public String getAttributeName();

   /**
    * Removes the attribute-name element 
    * @return the current instance of FacesConfigAttributeType 
    */
   public FacesConfigAttributeType removeAttributeName();

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

   /**
    * Sets the attribute-class element
    * @param attributeClass the value for the element attribute-class 
    * @return the current instance of FacesConfigAttributeType 
    */
   public FacesConfigAttributeType attributeClass(String attributeClass);

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

   /**
    * Removes the attribute-class element 
    * @return the current instance of FacesConfigAttributeType 
    */
   public FacesConfigAttributeType removeAttributeClass();

 
   // --------------------------------------------------------------------------------------------------------||
   // ClassName: FacesConfigAttributeType ElementName: javaee:string ElementType : default-value
   // MaxOccurs: -  isGeneric: true   isAttribute: false isEnum: false isDataType: true
   // --------------------------------------------------------------------------------------------------------||

   /**
    * Sets the default-value element
    * @param defaultValue the value for the element default-value 
    * @return the current instance of FacesConfigAttributeType 
    */
   public FacesConfigAttributeType defaultValue(String defaultValue);

   /**
    * Returns the default-value element
    * @return the node defined for the element default-value 
    */
   public String getDefaultValue();

   /**
    * Removes the default-value element 
    * @return the current instance of FacesConfigAttributeType 
    */
   public FacesConfigAttributeType removeDefaultValue();

 
   // --------------------------------------------------------------------------------------------------------||
   // ClassName: FacesConfigAttributeType ElementName: javaee:string ElementType : suggested-value
   // MaxOccurs: -  isGeneric: true   isAttribute: false isEnum: false isDataType: true
   // --------------------------------------------------------------------------------------------------------||

   /**
    * Sets the suggested-value element
    * @param suggestedValue the value for the element suggested-value 
    * @return the current instance of FacesConfigAttributeType 
    */
   public FacesConfigAttributeType suggestedValue(String suggestedValue);

   /**
    * Returns the suggested-value element
    * @return the node defined for the element suggested-value 
    */
   public String getSuggestedValue();

   /**
    * Removes the suggested-value element 
    * @return the current instance of FacesConfigAttributeType 
    */
   public FacesConfigAttributeType removeSuggestedValue();

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

   /**
    * Sets the attribute-extension element 
    * @return the current instance of FacesConfigAttributeType 
    */
   public FacesConfigAttributeType attributeExtension();

   /**
    * Removes the attribute-extension element 
    * @return the current instance of FacesConfigAttributeType 
    */
   public Boolean isAttributeExtension();

   /**
    * Removes the attribute-extension element 
    * @return the current instance of FacesConfigAttributeType 
    */
   public FacesConfigAttributeType removeAttributeExtension();

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