org.jboss.shrinkwrap.descriptor.api.orm21.Table 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.UniqueConstraint;
import org.jboss.shrinkwrap.descriptor.api.orm21.Index;
import org.jboss.shrinkwrap.descriptor.api.orm.*;
import org.jboss.shrinkwrap.descriptor.api.orm.OrmTableCommType;

import org.jboss.shrinkwrap.descriptor.api.orm21.UniqueConstraint;/**
 * This interface defines the contract for the  table  xsd type 
 * @author Ralf Battenfeld
 * @author Andrew Lee Rubinger
 */
public interface Table extends Child, 
    OrmTableCommType,
    UniqueConstraint>> { 

 
   // --------------------------------------------------------------------------------------------------------||
   // ClassName: Table ElementName: orm:unique-constraint ElementType : unique-constraint
   // MaxOccurs: -unbounded  isGeneric: true   isAttribute: false isEnum: false isDataType: false
   // --------------------------------------------------------------------------------------------------------||

   /**
    * If not already created, a new unique-constraint element will be created and returned.
    * Otherwise, the first existing unique-constraint element will be returned.
    * @return the instance defined for the element unique-constraint 
    */
   public UniqueConstraint> getOrCreateUniqueConstraint();

   /**
    * Creates a new unique-constraint element 
    * @return the new created instance of UniqueConstraint> 
    */
   public UniqueConstraint> createUniqueConstraint();

   /**
    * Returns all unique-constraint elements
    * @return list of unique-constraint 
    */
   public List>> getAllUniqueConstraint();

   /**
    * Removes all unique-constraint elements 
    * @return the current instance of UniqueConstraint> 
    */
   public Table removeAllUniqueConstraint();

 
   // --------------------------------------------------------------------------------------------------------||
   // ClassName: Table ElementName: orm:index ElementType : index
   // MaxOccurs: -unbounded  isGeneric: true   isAttribute: false isEnum: false isDataType: false
   // --------------------------------------------------------------------------------------------------------||

   /**
    * If not already created, a new index element will be created and returned.
    * Otherwise, the first existing index element will be returned.
    * @return the instance defined for the element index 
    */
   public Index> getOrCreateIndex();

   /**
    * Creates a new index element 
    * @return the new created instance of Index> 
    */
   public Index> createIndex();

   /**
    * Returns all index elements
    * @return list of index 
    */
   public List>> getAllIndex();

   /**
    * Removes all index elements 
    * @return the current instance of Index> 
    */
   public Table removeAllIndex();

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

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

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

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

   /**
    * Removes the catalog attribute 
    * @return the current instance of Table 
    */
   public Table removeCatalog();

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

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

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

   /**
    * Removes the schema attribute 
    * @return the current instance of Table 
    */
   public Table removeSchema();
}