org.jboss.shrinkwrap.descriptor.api.orm21.ForeignKey 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.ConstraintMode;
import org.jboss.shrinkwrap.descriptor.api.orm.*;
import org.jboss.shrinkwrap.descriptor.api.orm.OrmForeignKeyCommType;
/**
 * This interface defines the contract for the  foreign-key  xsd type 
 * @author Ralf Battenfeld
 * @author Andrew Lee Rubinger
 */
public interface ForeignKey extends Child, 
    OrmForeignKeyCommType> { 

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

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

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

   /**
    * Sets the constraint-mode attribute
    * @param constraintMode the value for the attribute constraint-mode 
    * @return the current instance of ForeignKey 
    */
   public ForeignKey constraintMode(ConstraintMode constraintMode);

   /**
    * Sets the constraint-mode attribute
    * @param constraintMode the value for the attribute constraint-mode 
    * @return the current instance of ForeignKey 
    */
   public ForeignKey constraintMode(String constraintMode);

   /**
    * Returns the constraint-mode attribute
    * @return the value defined for the attribute constraint-mode 
    */
public ConstraintMode getConstraintMode();

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

   /**
    * Removes the constraint-mode attribute 
    * @return the current instance of ForeignKey 
    */
   public ForeignKey removeConstraintMode();

 
   // --------------------------------------------------------------------------------------------------------||
   // ClassName: ForeignKey ElementName: xsd:string ElementType : foreign-key-definition
   // MaxOccurs: -  isGeneric: true   isAttribute: true isEnum: false isDataType: true
   // --------------------------------------------------------------------------------------------------------||

   /**
    * Sets the foreign-key-definition attribute
    * @param foreignKeyDefinition the value for the attribute foreign-key-definition 
    * @return the current instance of ForeignKey 
    */
   public ForeignKey foreignKeyDefinition(String foreignKeyDefinition);

   /**
    * Returns the foreign-key-definition attribute
    * @return the value defined for the attribute foreign-key-definition 
    */
   public String getForeignKeyDefinition();

   /**
    * Removes the foreign-key-definition attribute 
    * @return the current instance of ForeignKey 
    */
   public ForeignKey removeForeignKeyDefinition();
}