org.jboss.shrinkwrap.descriptor.api.orm21.Embeddable 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.EmbeddableAttributes;
import org.jboss.shrinkwrap.descriptor.api.orm21.AccessType;
import org.jboss.shrinkwrap.descriptor.api.orm.*;
import org.jboss.shrinkwrap.descriptor.api.orm.OrmEmbeddableCommType;

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

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

 
   // --------------------------------------------------------------------------------------------------------||
   // ClassName: Embeddable ElementName: orm:embeddable-attributes ElementType : attributes
   // MaxOccurs: -  isGeneric: true   isAttribute: false isEnum: false isDataType: false
   // --------------------------------------------------------------------------------------------------------||

   /**
    * If not already created, a new attributes element with the given value will be created.
    * Otherwise, the existing attributes element will be returned.
    * @return  a new or existing instance of EmbeddableAttributes> 
    */
   public EmbeddableAttributes> getOrCreateAttributes();

   /**
    * Removes the attributes element 
    * @return the current instance of Embeddable 
    */
   public Embeddable removeAttributes();

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

   /**
    * Sets the class attribute
    * @param clazz the value for the attribute class 
    * @return the current instance of Embeddable 
    */
   public Embeddable clazz(String clazz);

   /**
    * Returns the class attribute
    * @return the value defined for the attribute class 
    */
   public String getClazz();

   /**
    * Removes the class attribute 
    * @return the current instance of Embeddable 
    */
   public Embeddable removeClazzAttr();

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

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

 
   // --------------------------------------------------------------------------------------------------------||
   // ClassName: Embeddable ElementName: xsd:boolean ElementType : metadata-complete
   // MaxOccurs: -  isGeneric: true   isAttribute: true isEnum: false isDataType: true
   // --------------------------------------------------------------------------------------------------------||

   /**
    * Sets the metadata-complete attribute
    * @param metadataComplete the value for the attribute metadata-complete 
    * @return the current instance of Embeddable 
    */
   public Embeddable metadataComplete(Boolean metadataComplete);

   /**
    * Returns the metadata-complete attribute
    * @return the value defined for the attribute metadata-complete 
    */
public Boolean isMetadataComplete();

   /**
    * Removes the metadata-complete attribute 
    * @return the current instance of Embeddable 
    */
   public Embeddable removeMetadataComplete();
}