org.jboss.shrinkwrap.descriptor.api.orm20.PersistenceUnitMetadata 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.orm20; 

import java.util.ArrayList;
import java.util.List;
import org.jboss.shrinkwrap.descriptor.api.Child;
import org.jboss.shrinkwrap.descriptor.api.orm20.PersistenceUnitDefaults;
import org.jboss.shrinkwrap.descriptor.api.orm.*;
import org.jboss.shrinkwrap.descriptor.api.orm.OrmPersistenceUnitMetadataCommType;

import org.jboss.shrinkwrap.descriptor.api.orm20.PersistenceUnitDefaults;/**
 * This interface defines the contract for the  persistence-unit-metadata  xsd type 
 * @author Ralf Battenfeld
 * @author Andrew Lee Rubinger
 * @author George Gastaldi
 */
public interface PersistenceUnitMetadata extends Child, 
    OrmPersistenceUnitMetadataCommType,
    PersistenceUnitDefaults>> { 

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

 
   // --------------------------------------------------------------------------------------------------------||
   // ClassName: PersistenceUnitMetadata ElementName: javaee:emptyType ElementType : xml-mapping-metadata-complete
   // MaxOccurs: -  isGeneric: true   isAttribute: false isEnum: false isDataType: true
   // --------------------------------------------------------------------------------------------------------||

   /**
    * Sets the xml-mapping-metadata-complete element 
    * @return the current instance of PersistenceUnitMetadata 
    */
   public PersistenceUnitMetadata xmlMappingMetadataComplete();

   /**
    * Removes the xml-mapping-metadata-complete element 
    * @return the current instance of PersistenceUnitMetadata 
    */
   public Boolean isXmlMappingMetadataComplete();

   /**
    * Removes the xml-mapping-metadata-complete element 
    * @return the current instance of PersistenceUnitMetadata 
    */
   public PersistenceUnitMetadata removeXmlMappingMetadataComplete();

 
   // --------------------------------------------------------------------------------------------------------||
   // ClassName: PersistenceUnitMetadata ElementName: orm:persistence-unit-defaults ElementType : persistence-unit-defaults
   // MaxOccurs: -  isGeneric: true   isAttribute: false isEnum: false isDataType: false
   // --------------------------------------------------------------------------------------------------------||

   /**
    * If not already created, a new persistence-unit-defaults element with the given value will be created.
    * Otherwise, the existing persistence-unit-defaults element will be returned.
    * @return  a new or existing instance of PersistenceUnitDefaults> 
    */
   public PersistenceUnitDefaults> getOrCreatePersistenceUnitDefaults();

   /**
    * Removes the persistence-unit-defaults element 
    * @return the current instance of PersistenceUnitMetadata 
    */
   public PersistenceUnitMetadata removePersistenceUnitDefaults();
}