org.jboss.shrinkwrap.descriptor.api.orm21.StoredProcedureParameter 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.orm21.ParameterMode;
import org.jboss.shrinkwrap.descriptor.api.orm.*;
import org.jboss.shrinkwrap.descriptor.api.orm.OrmStoredProcedureParameterCommType;
/**
 * This interface defines the contract for the  stored-procedure-parameter  xsd type 
 * @author Ralf Battenfeld
 * @author Andrew Lee Rubinger
 */
public interface StoredProcedureParameter extends Child, 
    OrmStoredProcedureParameterCommType> { 

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

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

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

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

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

   /**
    * Removes the class attribute 
    * @return the current instance of StoredProcedureParameter 
    */
   public StoredProcedureParameter removeClazzAttr();

 
   // --------------------------------------------------------------------------------------------------------||
   // ClassName: StoredProcedureParameter ElementName: orm:parameter-mode ElementType : mode
   // MaxOccurs: -  isGeneric: true   isAttribute: true isEnum: true isDataType: false
   // --------------------------------------------------------------------------------------------------------||

   /**
    * Sets the mode attribute
    * @param mode the value for the attribute mode 
    * @return the current instance of StoredProcedureParameter 
    */
   public StoredProcedureParameter mode(ParameterMode mode);

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

   /**
    * Returns the mode attribute
    * @return the value defined for the attribute mode 
    */
public ParameterMode getMode();

   /**
    * Returns the mode attribute
    * @return the value found for the element mode 
    */
   public String  getModeAsString();

   /**
    * Removes the mode attribute 
    * @return the current instance of StoredProcedureParameter 
    */
   public StoredProcedureParameter removeMode();
}