org.jboss.shrinkwrap.descriptor.api.orm21.PersistenceUnitDefaults 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.AccessType;
import org.jboss.shrinkwrap.descriptor.api.orm21.EntityListeners;
import org.jboss.shrinkwrap.descriptor.api.orm.*;
import org.jboss.shrinkwrap.descriptor.api.orm.OrmPersistenceUnitDefaultsCommType;

import org.jboss.shrinkwrap.descriptor.api.orm21.EntityListeners;/**
 * This interface defines the contract for the  persistence-unit-defaults  xsd type 
 * @author Ralf Battenfeld
 * @author Andrew Lee Rubinger
 */
public interface PersistenceUnitDefaults extends Child, 
    OrmPersistenceUnitDefaultsCommType,
    EntityListeners>> { 

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

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

   /**
    * Sets the schema element
    * @param schema the value for the element schema 
    * @return the current instance of PersistenceUnitDefaults 
    */
   public PersistenceUnitDefaults schema(String schema);

   /**
    * Returns the schema element
    * @return the node defined for the element schema 
    */
   public String getSchema();

   /**
    * Removes the schema element 
    * @return the current instance of PersistenceUnitDefaults 
    */
   public PersistenceUnitDefaults removeSchema();

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

   /**
    * Sets the catalog element
    * @param catalog the value for the element catalog 
    * @return the current instance of PersistenceUnitDefaults 
    */
   public PersistenceUnitDefaults catalog(String catalog);

   /**
    * Returns the catalog element
    * @return the node defined for the element catalog 
    */
   public String getCatalog();

   /**
    * Removes the catalog element 
    * @return the current instance of PersistenceUnitDefaults 
    */
   public PersistenceUnitDefaults removeCatalog();

 
   // --------------------------------------------------------------------------------------------------------||
   // ClassName: PersistenceUnitDefaults ElementName: javaee:emptyType ElementType : delimited-identifiers
   // MaxOccurs: -  isGeneric: true   isAttribute: false isEnum: false isDataType: true
   // --------------------------------------------------------------------------------------------------------||

   /**
    * Sets the delimited-identifiers element 
    * @return the current instance of PersistenceUnitDefaults 
    */
   public PersistenceUnitDefaults delimitedIdentifiers();

   /**
    * Removes the delimited-identifiers element 
    * @return the current instance of PersistenceUnitDefaults 
    */
   public Boolean isDelimitedIdentifiers();

   /**
    * Removes the delimited-identifiers element 
    * @return the current instance of PersistenceUnitDefaults 
    */
   public PersistenceUnitDefaults removeDelimitedIdentifiers();

 
   // --------------------------------------------------------------------------------------------------------||
   // ClassName: PersistenceUnitDefaults ElementName: orm:access-type ElementType : access
   // MaxOccurs: -  isGeneric: true   isAttribute: false isEnum: true isDataType: false
   // --------------------------------------------------------------------------------------------------------||
   /**
    * Sets the access element
    * @param access the value for the element access 
    * @return the current instance of PersistenceUnitDefaults 
    */
   public PersistenceUnitDefaults access(AccessType access);
   /**
    * Sets the access element
    * @param access the value for the element access 
    * @return the current instance of PersistenceUnitDefaults 
    */
   public PersistenceUnitDefaults access(String access);

   /**
    * Returns the access element
    * @return the value found for the element access 
    */
   public AccessType getAccess();

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

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

 
   // --------------------------------------------------------------------------------------------------------||
   // ClassName: PersistenceUnitDefaults ElementName: javaee:emptyType ElementType : cascade-persist
   // MaxOccurs: -  isGeneric: true   isAttribute: false isEnum: false isDataType: true
   // --------------------------------------------------------------------------------------------------------||

   /**
    * Sets the cascade-persist element 
    * @return the current instance of PersistenceUnitDefaults 
    */
   public PersistenceUnitDefaults cascadePersist();

   /**
    * Removes the cascade-persist element 
    * @return the current instance of PersistenceUnitDefaults 
    */
   public Boolean isCascadePersist();

   /**
    * Removes the cascade-persist element 
    * @return the current instance of PersistenceUnitDefaults 
    */
   public PersistenceUnitDefaults removeCascadePersist();

 
   // --------------------------------------------------------------------------------------------------------||
   // ClassName: PersistenceUnitDefaults ElementName: orm:entity-listeners ElementType : entity-listeners
   // MaxOccurs: -  isGeneric: true   isAttribute: false isEnum: false isDataType: false
   // --------------------------------------------------------------------------------------------------------||

   /**
    * If not already created, a new entity-listeners element with the given value will be created.
    * Otherwise, the existing entity-listeners element will be returned.
    * @return  a new or existing instance of EntityListeners> 
    */
   public EntityListeners> getOrCreateEntityListeners();

   /**
    * Removes the entity-listeners element 
    * @return the current instance of PersistenceUnitDefaults 
    */
   public PersistenceUnitDefaults removeEntityListeners();
}