org.jboss.shrinkwrap.descriptor.api.facespartialresponse22.WebFacesPartialResponseDescriptor 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.facespartialresponse22; 

import java.util.ArrayList;
import java.util.List;
import org.jboss.shrinkwrap.descriptor.api.Child;
import org.jboss.shrinkwrap.descriptor.api.facespartialresponse22.PartialResponseChangesType;
import org.jboss.shrinkwrap.descriptor.api.facespartialresponse22.PartialResponseRedirectType;
import org.jboss.shrinkwrap.descriptor.api.facespartialresponse22.PartialResponseErrorType;
import org.jboss.shrinkwrap.descriptor.api.Descriptor;
import org.jboss.shrinkwrap.descriptor.api.DescriptorNamespace;

import org.jboss.shrinkwrap.descriptor.api.facespartialresponse.*;
/** 
 *  
 * This deployment descriptor provides the functionalities as described in the  specification
 * 
 
 * Example:
 *  
 *  
 *     WebFacesPartialResponseDescriptor descriptor = Descriptors.create(WebFacesPartialResponseDescriptor.class);
 *  
 *
 *
 * @author Ralf Battenfeld
 * @author Andrew Lee Rubinger
 */
public interface WebFacesPartialResponseDescriptor extends Descriptor, DescriptorNamespace, 
    WebFacesPartialResponseCommonDescriptor, 
    PartialResponseRedirectType, 
    PartialResponseErrorType> {

 
   // --------------------------------------------------------------------------------------------------------||
   // ClassName: WebFacesPartialResponseDescriptor ElementName: javaee:partial-response-changesType ElementType : changes
   // MaxOccurs: -1  isGeneric: false   isAttribute: false isEnum: false isDataType: false
   // --------------------------------------------------------------------------------------------------------||

   /**
    * If not already created, a new changes element with the given value will be created.
    * Otherwise, the existing changes element will be returned.
    * @return  a new or existing instance of PartialResponseChangesType 
    */
   public PartialResponseChangesType getOrCreateChanges();

   /**
    * Removes the changes element 
    * @return the current instance of WebFacesPartialResponseDescriptor 
    */
   public WebFacesPartialResponseDescriptor removeChanges();
 
   // --------------------------------------------------------------------------------------------------------||
   // ClassName: WebFacesPartialResponseDescriptor ElementName: javaee:partial-response-redirectType ElementType : redirect
   // MaxOccurs: -1  isGeneric: false   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 PartialResponseRedirectType 
    */
   public PartialResponseRedirectType getOrCreateRedirect();

   /**
    * Removes the redirect element 
    * @return the current instance of WebFacesPartialResponseDescriptor 
    */
   public WebFacesPartialResponseDescriptor removeRedirect();
 
   // --------------------------------------------------------------------------------------------------------||
   // ClassName: WebFacesPartialResponseDescriptor ElementName: javaee:partial-response-errorType ElementType : error
   // MaxOccurs: -1  isGeneric: false   isAttribute: false isEnum: false isDataType: false
   // --------------------------------------------------------------------------------------------------------||

   /**
    * If not already created, a new error element with the given value will be created.
    * Otherwise, the existing error element will be returned.
    * @return  a new or existing instance of PartialResponseErrorType 
    */
   public PartialResponseErrorType getOrCreateError();

   /**
    * Removes the error element 
    * @return the current instance of WebFacesPartialResponseDescriptor 
    */
   public WebFacesPartialResponseDescriptor removeError();
 
   // --------------------------------------------------------------------------------------------------------||
   // ClassName: WebFacesPartialResponseDescriptor ElementName: xsd:ID ElementType : id
   // MaxOccurs: -  isGeneric: false   isAttribute: true isEnum: false isDataType: true
   // --------------------------------------------------------------------------------------------------------||

   /**
    * Sets the id attribute
    * @param id the value for the attribute id 
    * @return the current instance of WebFacesPartialResponseDescriptor 
    */
   public WebFacesPartialResponseDescriptor 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 WebFacesPartialResponseDescriptor 
    */
   public WebFacesPartialResponseDescriptor removeId();
}