org.jboss.shrinkwrap.descriptor.api.orm10.JoinColumn 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.orm10; 

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.OrmJoinColumnCommType;
/**
 * This interface defines the contract for the  join-column  xsd type 
 * @author Ralf Battenfeld
 * @author Andrew Lee Rubinger
 * @author George Gastaldi
 */
public interface JoinColumn extends Child, 
    OrmJoinColumnCommType> { 

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

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

   /**
    * Sets the referenced-column-name attribute
    * @param referencedColumnName the value for the attribute referenced-column-name 
    * @return the current instance of JoinColumn 
    */
   public JoinColumn referencedColumnName(String referencedColumnName);

   /**
    * Returns the referenced-column-name attribute
    * @return the value defined for the attribute referenced-column-name 
    */
   public String getReferencedColumnName();

   /**
    * Removes the referenced-column-name attribute 
    * @return the current instance of JoinColumn 
    */
   public JoinColumn removeReferencedColumnName();

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

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

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

   /**
    * Returns the nullable attribute
    * @return the value defined for the attribute nullable 
    */
public Boolean isNullable();

   /**
    * Removes the nullable attribute 
    * @return the current instance of JoinColumn 
    */
   public JoinColumn removeNullable();

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

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

   /**
    * Returns the insertable attribute
    * @return the value defined for the attribute insertable 
    */
public Boolean isInsertable();

   /**
    * Removes the insertable attribute 
    * @return the current instance of JoinColumn 
    */
   public JoinColumn removeInsertable();

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

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

   /**
    * Returns the updatable attribute
    * @return the value defined for the attribute updatable 
    */
public Boolean isUpdatable();

   /**
    * Removes the updatable attribute 
    * @return the current instance of JoinColumn 
    */
   public JoinColumn removeUpdatable();

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

   /**
    * Sets the column-definition attribute
    * @param columnDefinition the value for the attribute column-definition 
    * @return the current instance of JoinColumn 
    */
   public JoinColumn columnDefinition(String columnDefinition);

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

   /**
    * Removes the column-definition attribute 
    * @return the current instance of JoinColumn 
    */
   public JoinColumn removeColumnDefinition();

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

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

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

   /**
    * Removes the table attribute 
    * @return the current instance of JoinColumn 
    */
   public JoinColumn removeTable();
}