• Home
• org.projectodd.shrinkwrap.descriptors
• shrinkwrap-descriptors-api-javaee
• 2.0.0-alpha-7a
• source code
• MappedSuperclass.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

org.jboss.shrinkwrap.descriptor.api.orm21.MappedSuperclass 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.IdClass;
import org.jboss.shrinkwrap.descriptor.api.orm21.EntityListeners;
import org.jboss.shrinkwrap.descriptor.api.orm21.PrePersist;
import org.jboss.shrinkwrap.descriptor.api.orm21.PostPersist;
import org.jboss.shrinkwrap.descriptor.api.orm21.PreRemove;
import org.jboss.shrinkwrap.descriptor.api.orm21.PostRemove;
import org.jboss.shrinkwrap.descriptor.api.orm21.PreUpdate;
import org.jboss.shrinkwrap.descriptor.api.orm21.PostUpdate;
import org.jboss.shrinkwrap.descriptor.api.orm21.PostLoad;
import org.jboss.shrinkwrap.descriptor.api.orm21.Attributes;
import org.jboss.shrinkwrap.descriptor.api.orm21.AccessType;
import org.jboss.shrinkwrap.descriptor.api.orm.*;
import org.jboss.shrinkwrap.descriptor.api.orm.OrmMappedSuperclassCommType;

import org.jboss.shrinkwrap.descriptor.api.orm21.IdClass;
import org.jboss.shrinkwrap.descriptor.api.orm21.EntityListeners;
import org.jboss.shrinkwrap.descriptor.api.orm21.PrePersist;
import org.jboss.shrinkwrap.descriptor.api.orm21.PostPersist;
import org.jboss.shrinkwrap.descriptor.api.orm21.PreRemove;
import org.jboss.shrinkwrap.descriptor.api.orm21.PostRemove;
import org.jboss.shrinkwrap.descriptor.api.orm21.PreUpdate;
import org.jboss.shrinkwrap.descriptor.api.orm21.PostUpdate;
import org.jboss.shrinkwrap.descriptor.api.orm21.PostLoad;
import org.jboss.shrinkwrap.descriptor.api.orm21.Attributes;/**
 * This interface defines the contract for the  mapped-superclass  xsd type 
 * @author Ralf Battenfeld
 * @author Andrew Lee Rubinger
 */
public interface MappedSuperclass extends Child, 
    OrmMappedSuperclassCommType,
    IdClass>,
    EntityListeners>,
    PrePersist>,
    PostPersist>,
    PreRemove>,
    PostRemove>,
    PreUpdate>,
    PostUpdate>,
    PostLoad>,
    Attributes>> { 

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

 
   // --------------------------------------------------------------------------------------------------------||
   // ClassName: MappedSuperclass ElementName: orm:id-class ElementType : id-class
   // MaxOccurs: -  isGeneric: true   isAttribute: false isEnum: false isDataType: false
   // --------------------------------------------------------------------------------------------------------||

   /**
    * If not already created, a new id-class element with the given value will be created.
    * Otherwise, the existing id-class element will be returned.
    * @return  a new or existing instance of IdClass> 
    */
   public IdClass> getOrCreateIdClass();

   /**
    * Removes the id-class element 
    * @return the current instance of MappedSuperclass 
    */
   public MappedSuperclass removeIdClass();

 
   // --------------------------------------------------------------------------------------------------------||
   // ClassName: MappedSuperclass ElementName: javaee:emptyType ElementType : exclude-default-listeners
   // MaxOccurs: -  isGeneric: true   isAttribute: false isEnum: false isDataType: true
   // --------------------------------------------------------------------------------------------------------||

   /**
    * Sets the exclude-default-listeners element 
    * @return the current instance of MappedSuperclass 
    */
   public MappedSuperclass excludeDefaultListeners();

   /**
    * Removes the exclude-default-listeners element 
    * @return the current instance of MappedSuperclass 
    */
   public Boolean isExcludeDefaultListeners();

   /**
    * Removes the exclude-default-listeners element 
    * @return the current instance of MappedSuperclass 
    */
   public MappedSuperclass removeExcludeDefaultListeners();

 
   // --------------------------------------------------------------------------------------------------------||
   // ClassName: MappedSuperclass ElementName: javaee:emptyType ElementType : exclude-superclass-listeners
   // MaxOccurs: -  isGeneric: true   isAttribute: false isEnum: false isDataType: true
   // --------------------------------------------------------------------------------------------------------||

   /**
    * Sets the exclude-superclass-listeners element 
    * @return the current instance of MappedSuperclass 
    */
   public MappedSuperclass excludeSuperclassListeners();

   /**
    * Removes the exclude-superclass-listeners element 
    * @return the current instance of MappedSuperclass 
    */
   public Boolean isExcludeSuperclassListeners();

   /**
    * Removes the exclude-superclass-listeners element 
    * @return the current instance of MappedSuperclass 
    */
   public MappedSuperclass removeExcludeSuperclassListeners();

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

 
   // --------------------------------------------------------------------------------------------------------||
   // ClassName: MappedSuperclass ElementName: orm:pre-persist ElementType : pre-persist
   // MaxOccurs: -  isGeneric: true   isAttribute: false isEnum: false isDataType: false
   // --------------------------------------------------------------------------------------------------------||

   /**
    * If not already created, a new pre-persist element with the given value will be created.
    * Otherwise, the existing pre-persist element will be returned.
    * @return  a new or existing instance of PrePersist> 
    */
   public PrePersist> getOrCreatePrePersist();

   /**
    * Removes the pre-persist element 
    * @return the current instance of MappedSuperclass 
    */
   public MappedSuperclass removePrePersist();

 
   // --------------------------------------------------------------------------------------------------------||
   // ClassName: MappedSuperclass ElementName: orm:post-persist ElementType : post-persist
   // MaxOccurs: -  isGeneric: true   isAttribute: false isEnum: false isDataType: false
   // --------------------------------------------------------------------------------------------------------||

   /**
    * If not already created, a new post-persist element with the given value will be created.
    * Otherwise, the existing post-persist element will be returned.
    * @return  a new or existing instance of PostPersist> 
    */
   public PostPersist> getOrCreatePostPersist();

   /**
    * Removes the post-persist element 
    * @return the current instance of MappedSuperclass 
    */
   public MappedSuperclass removePostPersist();

 
   // --------------------------------------------------------------------------------------------------------||
   // ClassName: MappedSuperclass ElementName: orm:pre-remove ElementType : pre-remove
   // MaxOccurs: -  isGeneric: true   isAttribute: false isEnum: false isDataType: false
   // --------------------------------------------------------------------------------------------------------||

   /**
    * If not already created, a new pre-remove element with the given value will be created.
    * Otherwise, the existing pre-remove element will be returned.
    * @return  a new or existing instance of PreRemove> 
    */
   public PreRemove> getOrCreatePreRemove();

   /**
    * Removes the pre-remove element 
    * @return the current instance of MappedSuperclass 
    */
   public MappedSuperclass removePreRemove();

 
   // --------------------------------------------------------------------------------------------------------||
   // ClassName: MappedSuperclass ElementName: orm:post-remove ElementType : post-remove
   // MaxOccurs: -  isGeneric: true   isAttribute: false isEnum: false isDataType: false
   // --------------------------------------------------------------------------------------------------------||

   /**
    * If not already created, a new post-remove element with the given value will be created.
    * Otherwise, the existing post-remove element will be returned.
    * @return  a new or existing instance of PostRemove> 
    */
   public PostRemove> getOrCreatePostRemove();

   /**
    * Removes the post-remove element 
    * @return the current instance of MappedSuperclass 
    */
   public MappedSuperclass removePostRemove();

 
   // --------------------------------------------------------------------------------------------------------||
   // ClassName: MappedSuperclass ElementName: orm:pre-update ElementType : pre-update
   // MaxOccurs: -  isGeneric: true   isAttribute: false isEnum: false isDataType: false
   // --------------------------------------------------------------------------------------------------------||

   /**
    * If not already created, a new pre-update element with the given value will be created.
    * Otherwise, the existing pre-update element will be returned.
    * @return  a new or existing instance of PreUpdate> 
    */
   public PreUpdate> getOrCreatePreUpdate();

   /**
    * Removes the pre-update element 
    * @return the current instance of MappedSuperclass 
    */
   public MappedSuperclass removePreUpdate();

 
   // --------------------------------------------------------------------------------------------------------||
   // ClassName: MappedSuperclass ElementName: orm:post-update ElementType : post-update
   // MaxOccurs: -  isGeneric: true   isAttribute: false isEnum: false isDataType: false
   // --------------------------------------------------------------------------------------------------------||

   /**
    * If not already created, a new post-update element with the given value will be created.
    * Otherwise, the existing post-update element will be returned.
    * @return  a new or existing instance of PostUpdate> 
    */
   public PostUpdate> getOrCreatePostUpdate();

   /**
    * Removes the post-update element 
    * @return the current instance of MappedSuperclass 
    */
   public MappedSuperclass removePostUpdate();

 
   // --------------------------------------------------------------------------------------------------------||
   // ClassName: MappedSuperclass ElementName: orm:post-load ElementType : post-load
   // MaxOccurs: -  isGeneric: true   isAttribute: false isEnum: false isDataType: false
   // --------------------------------------------------------------------------------------------------------||

   /**
    * If not already created, a new post-load element with the given value will be created.
    * Otherwise, the existing post-load element will be returned.
    * @return  a new or existing instance of PostLoad> 
    */
   public PostLoad> getOrCreatePostLoad();

   /**
    * Removes the post-load element 
    * @return the current instance of MappedSuperclass 
    */
   public MappedSuperclass removePostLoad();

 
   // --------------------------------------------------------------------------------------------------------||
   // ClassName: MappedSuperclass ElementName: orm: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 Attributes> 
    */
   public Attributes> getOrCreateAttributes();

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

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

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

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

 
   // --------------------------------------------------------------------------------------------------------||
   // ClassName: MappedSuperclass 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 MappedSuperclass 
    */
   public MappedSuperclass 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 MappedSuperclass 
    */
   public MappedSuperclass removeMetadataComplete();
}