org.jboss.shrinkwrap.descriptor.api.portletapp20.FilterMappingType Maven / Gradle / Ivy

package org.jboss.shrinkwrap.descriptor.api.portletapp20; 

import java.util.ArrayList;
import java.util.List;
import org.jboss.shrinkwrap.descriptor.api.Child;
import org.jboss.shrinkwrap.descriptor.api.portletapp.*;
import org.jboss.shrinkwrap.descriptor.api.portletapp.PortletFilterMappingCommonType;
/**
 * This interface defines the contract for the  filter-mappingType  xsd type 
 * @author Ralf Battenfeld
 * @author Andrew Lee Rubinger
 * @author George Gastaldi
 */
public interface FilterMappingType extends Child, 
    PortletFilterMappingCommonType> { 

 
   // --------------------------------------------------------------------------------------------------------||
   // ClassName: FilterMappingType ElementName: portlet:string ElementType : filter-name
   // MaxOccurs: -  isGeneric: true   isAttribute: false isEnum: false isDataType: true
   // --------------------------------------------------------------------------------------------------------||

   /**
    * Sets the filter-name element
    * @param filterName the value for the element filter-name 
    * @return the current instance of FilterMappingType 
    */
   public FilterMappingType filterName(String filterName);

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

   /**
    * Removes the filter-name element 
    * @return the current instance of FilterMappingType 
    */
   public FilterMappingType removeFilterName();

 
   // --------------------------------------------------------------------------------------------------------||
   // ClassName: FilterMappingType ElementName: string ElementType : portlet-name
   // MaxOccurs: -unbounded  isGeneric: true   isAttribute: false isEnum: false isDataType: true
   // --------------------------------------------------------------------------------------------------------||

   /**
    * Creates for all String objects representing portlet-name elements, 
    * a new portlet-name element 
    * @param values list of portlet-name objects 
    * @return the current instance of FilterMappingType 
    */
   public FilterMappingType portletName(String ... values);

   /**
    * Returns all portlet-name elements
    * @return list of portlet-name 
    */
   public List getAllPortletName();

   /**
    * Removes the portlet-name element 
    * @return the current instance of FilterMappingType 
    */
   public FilterMappingType removeAllPortletName();
}