org.jboss.shrinkwrap.descriptor.api.orm21.QueryHint Maven / Gradle / Ivy

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

import java.util.ArrayList;
import java.util.List;
import org.jboss.shrinkwrap.descriptor.api.Child;
import org.jboss.shrinkwrap.descriptor.api.orm.*;
import org.jboss.shrinkwrap.descriptor.api.orm.OrmQueryHintCommType;
/**
 * This interface defines the contract for the  query-hint  xsd type 
 * @author Ralf Battenfeld
 * @author Andrew Lee Rubinger
 */
public interface QueryHint extends Child, 
    OrmQueryHintCommType> { 

 
   // --------------------------------------------------------------------------------------------------------||
   // ClassName: QueryHint ElementName: xsd:string ElementType : description
   // MaxOccurs: -  isGeneric: true   isAttribute: false isEnum: false isDataType: true
   // --------------------------------------------------------------------------------------------------------||

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

   /**
    * Returns the description element
    * @return the node defined for the element description 
    */
   public String getDescription();

   /**
    * Removes the description element 
    * @return the current instance of QueryHint 
    */
   public QueryHint removeDescription();

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

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

   /**
    * Returns the name attribute
    * @return the value defined for the attribute name 
    */
   public String getName();

   /**
    * Removes the name attribute 
    * @return the current instance of QueryHint 
    */
   public QueryHint removeName();

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

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

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

   /**
    * Removes the value attribute 
    * @return the current instance of QueryHint 
    */
   public QueryHint removeValue();
}