org.jboss.shrinkwrap.descriptor.api.orm21.Embedded 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.orm21.AttributeOverride;
import org.jboss.shrinkwrap.descriptor.api.orm21.AssociationOverride;
import org.jboss.shrinkwrap.descriptor.api.orm21.Convert;
import org.jboss.shrinkwrap.descriptor.api.orm21.AccessType;
import org.jboss.shrinkwrap.descriptor.api.orm.*;
import org.jboss.shrinkwrap.descriptor.api.orm.OrmEmbeddedCommType;

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

 
   // --------------------------------------------------------------------------------------------------------||
   // ClassName: Embedded ElementName: orm:attribute-override ElementType : attribute-override
   // MaxOccurs: -unbounded  isGeneric: true   isAttribute: false isEnum: false isDataType: false
   // --------------------------------------------------------------------------------------------------------||

   /**
    * If not already created, a new attribute-override element will be created and returned.
    * Otherwise, the first existing attribute-override element will be returned.
    * @return the instance defined for the element attribute-override 
    */
   public AttributeOverride> getOrCreateAttributeOverride();

   /**
    * Creates a new attribute-override element 
    * @return the new created instance of AttributeOverride> 
    */
   public AttributeOverride> createAttributeOverride();

   /**
    * Returns all attribute-override elements
    * @return list of attribute-override 
    */
   public List>> getAllAttributeOverride();

   /**
    * Removes all attribute-override elements 
    * @return the current instance of AttributeOverride> 
    */
   public Embedded removeAllAttributeOverride();

 
   // --------------------------------------------------------------------------------------------------------||
   // ClassName: Embedded ElementName: orm:association-override ElementType : association-override
   // MaxOccurs: -unbounded  isGeneric: true   isAttribute: false isEnum: false isDataType: false
   // --------------------------------------------------------------------------------------------------------||

   /**
    * If not already created, a new association-override element will be created and returned.
    * Otherwise, the first existing association-override element will be returned.
    * @return the instance defined for the element association-override 
    */
   public AssociationOverride> getOrCreateAssociationOverride();

   /**
    * Creates a new association-override element 
    * @return the new created instance of AssociationOverride> 
    */
   public AssociationOverride> createAssociationOverride();

   /**
    * Returns all association-override elements
    * @return list of association-override 
    */
   public List>> getAllAssociationOverride();

   /**
    * Removes all association-override elements 
    * @return the current instance of AssociationOverride> 
    */
   public Embedded removeAllAssociationOverride();

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

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

   /**
    * Creates a new convert element 
    * @return the new created instance of Convert> 
    */
   public Convert> createConvert();

   /**
    * Returns all convert elements
    * @return list of convert 
    */
   public List>> getAllConvert();

   /**
    * Removes all convert elements 
    * @return the current instance of Convert> 
    */
   public Embedded removeAllConvert();

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

 
   // --------------------------------------------------------------------------------------------------------||
   // ClassName: Embedded ElementName: orm:access-type ElementType : access
   // MaxOccurs: -  isGeneric: true   isAttribute: true isEnum: true isDataType: false
   // --------------------------------------------------------------------------------------------------------||

   /**
    * Sets the access attribute
    * @param access the value for the attribute access 
    * @return the current instance of Embedded 
    */
   public Embedded access(AccessType access);

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

   /**
    * Returns the access attribute
    * @return the value defined for the attribute access 
    */
public AccessType getAccess();

   /**
    * Returns the access attribute
    * @return the value found for the element access 
    */
   public String  getAccessAsString();

   /**
    * Removes the access attribute 
    * @return the current instance of Embedded 
    */
   public Embedded removeAccess();
}