org.jboss.shrinkwrap.descriptor.api.orm21.Index 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.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.OrmIndexCommType;
/**
 * This interface defines the contract for the  index  xsd type 
 * @author Ralf Battenfeld
 * @author Andrew Lee Rubinger
 */
public interface Index extends Child, 
    OrmIndexCommType> { 

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

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

 
   // --------------------------------------------------------------------------------------------------------||
   // ClassName: Index ElementName: xsd:string ElementType : column-list
   // MaxOccurs: -  isGeneric: true   isAttribute: true isEnum: false isDataType: true
   // --------------------------------------------------------------------------------------------------------||

   /**
    * Sets the column-list attribute
    * @param columnList the value for the attribute column-list 
    * @return the current instance of Index 
    */
   public Index columnList(String columnList);

   /**
    * Returns the column-list attribute
    * @return the value defined for the attribute column-list 
    */
   public String getColumnList();

   /**
    * Removes the column-list attribute 
    * @return the current instance of Index 
    */
   public Index removeColumnList();

 
   // --------------------------------------------------------------------------------------------------------||
   // ClassName: Index ElementName: xsd:boolean ElementType : unique
   // MaxOccurs: -  isGeneric: true   isAttribute: true isEnum: false isDataType: true
   // --------------------------------------------------------------------------------------------------------||

   /**
    * Sets the unique attribute
    * @param unique the value for the attribute unique 
    * @return the current instance of Index 
    */
   public Index unique(Boolean unique);

   /**
    * Returns the unique attribute
    * @return the value defined for the attribute unique 
    */
public Boolean isUnique();

   /**
    * Removes the unique attribute 
    * @return the current instance of Index 
    */
   public Index removeUnique();
}