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

 
   // --------------------------------------------------------------------------------------------------------||
   // ClassName: PreferenceType 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 PreferenceType 
    */
   public PreferenceType 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 PreferenceType 
    */
   public PreferenceType removeName();

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

   /**
    * Creates for all String objects representing value elements, 
    * a new value element 
    * @param values list of value objects 
    * @return the current instance of PreferenceType 
    */
   public PreferenceType value(String ... values);

   /**
    * Returns all value elements
    * @return list of value 
    */
   public List getAllValue();

   /**
    * Removes the value element 
    * @return the current instance of PreferenceType 
    */
   public PreferenceType removeAllValue();

 
   // --------------------------------------------------------------------------------------------------------||
   // ClassName: PreferenceType ElementName: portlet:read-onlyType ElementType : read-only
   // MaxOccurs: -  isGeneric: true   isAttribute: false isEnum: true isDataType: false
   // --------------------------------------------------------------------------------------------------------||
   /**
    * Sets the read-only element
    * @param readOnly the value for the element read-only 
    * @return the current instance of PreferenceType 
    */
   public PreferenceType readOnly(ReadOnlyType readOnly);
   /**
    * Sets the read-only element
    * @param readOnly the value for the element read-only 
    * @return the current instance of PreferenceType 
    */
   public PreferenceType readOnly(String readOnly);

   /**
    * Returns the read-only element
    * @return the value found for the element read-only 
    */
   public ReadOnlyType getReadOnly();

   /**
    * Returns the read-only element
    * @return the value found for the element read-only 
    */
   public String  getReadOnlyAsString();

   /**
    * Removes the read-only attribute 
    * @return the current instance of PreferenceType 
    */
   public PreferenceType removeReadOnly();

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