org.jboss.shrinkwrap.descriptor.api.orm10.EmbeddableAttributes 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.orm10.Basic;
import org.jboss.shrinkwrap.descriptor.api.orm10.Transient;
import org.jboss.shrinkwrap.descriptor.api.orm.*;
import org.jboss.shrinkwrap.descriptor.api.orm.OrmEmbeddableAttributesCommType;

import org.jboss.shrinkwrap.descriptor.api.orm10.Basic;
import org.jboss.shrinkwrap.descriptor.api.orm10.Transient;/**
 * This interface defines the contract for the  embeddable-attributes  xsd type 
 * @author Ralf Battenfeld
 * @author Andrew Lee Rubinger
 * @author George Gastaldi
 */
public interface EmbeddableAttributes extends Child, 
    OrmEmbeddableAttributesCommType,
    Basic>,
    Transient>> { 

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

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

   /**
    * Creates a new basic element 
    * @return the new created instance of Basic> 
    */
   public Basic> createBasic();

   /**
    * Returns all basic elements
    * @return list of basic 
    */
   public List>> getAllBasic();

   /**
    * Removes all basic elements 
    * @return the current instance of Basic> 
    */
   public EmbeddableAttributes removeAllBasic();

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

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

   /**
    * Creates a new transient element 
    * @return the new created instance of Transient> 
    */
   public Transient> createTransient();

   /**
    * Returns all transient elements
    * @return list of transient 
    */
   public List>> getAllTransient();

   /**
    * Removes all transient elements 
    * @return the current instance of Transient> 
    */
   public EmbeddableAttributes removeAllTransient();
}