org.jboss.shrinkwrap.descriptor.api.orm21.EmbeddedId 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.AttributeOverride;
import org.jboss.shrinkwrap.descriptor.api.orm21.AccessType;
import org.jboss.shrinkwrap.descriptor.api.orm.*;
import org.jboss.shrinkwrap.descriptor.api.orm.OrmEmbeddedIdCommType;

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

 
   // --------------------------------------------------------------------------------------------------------||
   // ClassName: EmbeddedId 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 EmbeddedId removeAllAttributeOverride();

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

 
   // --------------------------------------------------------------------------------------------------------||
   // ClassName: EmbeddedId 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 EmbeddedId 
    */
   public EmbeddedId access(AccessType access);

   /**
    * Sets the access attribute
    * @param access the value for the attribute access 
    * @return the current instance of EmbeddedId 
    */
   public EmbeddedId 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 EmbeddedId 
    */
   public EmbeddedId removeAccess();
}