org.jboss.shrinkwrap.descriptor.api.portletapp20.InitParamType 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.PortletInitParamCommonType;
/**
 * This interface defines the contract for the  init-paramType  xsd type 
 * @author Ralf Battenfeld
 * @author Andrew Lee Rubinger
 * @author George Gastaldi
 */
public interface InitParamType extends Child, 
    PortletInitParamCommonType> { 

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

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

   /**
    * Removes the description element 
    * @return the current instance of InitParamType 
    */
   public InitParamType removeAllDescription();

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

   /**
    * Sets the name element
    * @param name the value for the element name 
    * @return the current instance of InitParamType 
    */
   public InitParamType name(String name);

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

   /**
    * Removes the name element 
    * @return the current instance of InitParamType 
    */
   public InitParamType removeName();

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

   /**
    * Sets the value element
    * @param value the value for the element value 
    * @return the current instance of InitParamType 
    */
   public InitParamType value(String value);

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

   /**
    * Removes the value element 
    * @return the current instance of InitParamType 
    */
   public InitParamType removeValue();

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