org.jboss.shrinkwrap.descriptor.api.orm20.SqlResultSetMapping Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of shrinkwrap-descriptors-api-javaee Show documentation
Client View of the ShrinkWrap Descriptors Project
The newest version!
package org.jboss.shrinkwrap.descriptor.api.orm20; 

import java.util.ArrayList;
import java.util.List;
import org.jboss.shrinkwrap.descriptor.api.Child;
import org.jboss.shrinkwrap.descriptor.api.orm20.EntityResult;
import org.jboss.shrinkwrap.descriptor.api.orm20.ColumnResult;
import org.jboss.shrinkwrap.descriptor.api.orm.*;
import org.jboss.shrinkwrap.descriptor.api.orm.OrmSqlResultSetMappingCommType;

import org.jboss.shrinkwrap.descriptor.api.orm20.EntityResult;
import org.jboss.shrinkwrap.descriptor.api.orm20.ColumnResult;/**
 * This interface defines the contract for the  sql-result-set-mapping  xsd type 
 * @author Ralf Battenfeld
 * @author Andrew Lee Rubinger
 * @author George Gastaldi
 */
public interface SqlResultSetMapping extends Child, 
    OrmSqlResultSetMappingCommType,
    EntityResult>,
    ColumnResult>> { 

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

 
   // --------------------------------------------------------------------------------------------------------||
   // ClassName: SqlResultSetMapping ElementName: orm:entity-result ElementType : entity-result
   // MaxOccurs: -unbounded  isGeneric: true   isAttribute: false isEnum: false isDataType: false
   // --------------------------------------------------------------------------------------------------------||

   /**
    * If not already created, a new entity-result element will be created and returned.
    * Otherwise, the first existing entity-result element will be returned.
    * @return the instance defined for the element entity-result 
    */
   public EntityResult> getOrCreateEntityResult();

   /**
    * Creates a new entity-result element 
    * @return the new created instance of EntityResult> 
    */
   public EntityResult> createEntityResult();

   /**
    * Returns all entity-result elements
    * @return list of entity-result 
    */
   public List>> getAllEntityResult();

   /**
    * Removes all entity-result elements 
    * @return the current instance of EntityResult> 
    */
   public SqlResultSetMapping removeAllEntityResult();

 
   // --------------------------------------------------------------------------------------------------------||
   // ClassName: SqlResultSetMapping ElementName: orm:column-result ElementType : column-result
   // MaxOccurs: -unbounded  isGeneric: true   isAttribute: false isEnum: false isDataType: false
   // --------------------------------------------------------------------------------------------------------||

   /**
    * If not already created, a new column-result element will be created and returned.
    * Otherwise, the first existing column-result element will be returned.
    * @return the instance defined for the element column-result 
    */
   public ColumnResult> getOrCreateColumnResult();

   /**
    * Creates a new column-result element 
    * @return the new created instance of ColumnResult> 
    */
   public ColumnResult> createColumnResult();

   /**
    * Returns all column-result elements
    * @return list of column-result 
    */
   public List>> getAllColumnResult();

   /**
    * Removes all column-result elements 
    * @return the current instance of ColumnResult> 
    */
   public SqlResultSetMapping removeAllColumnResult();

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