org.jboss.shrinkwrap.descriptor.api.orm10.EntityListener Maven / Gradle / Ivy
package org.jboss.shrinkwrap.descriptor.api.orm10;
import java.util.ArrayList;
import java.util.List;
import org.jboss.shrinkwrap.descriptor.api.Child;
import org.jboss.shrinkwrap.descriptor.api.orm10.PrePersist;
import org.jboss.shrinkwrap.descriptor.api.orm10.PostPersist;
import org.jboss.shrinkwrap.descriptor.api.orm10.PreRemove;
import org.jboss.shrinkwrap.descriptor.api.orm10.PostRemove;
import org.jboss.shrinkwrap.descriptor.api.orm10.PreUpdate;
import org.jboss.shrinkwrap.descriptor.api.orm10.PostUpdate;
import org.jboss.shrinkwrap.descriptor.api.orm10.PostLoad;
import org.jboss.shrinkwrap.descriptor.api.orm.*;
import org.jboss.shrinkwrap.descriptor.api.orm.OrmEntityListenerCommType;
import org.jboss.shrinkwrap.descriptor.api.orm10.PrePersist;
import org.jboss.shrinkwrap.descriptor.api.orm10.PostPersist;
import org.jboss.shrinkwrap.descriptor.api.orm10.PreRemove;
import org.jboss.shrinkwrap.descriptor.api.orm10.PostRemove;
import org.jboss.shrinkwrap.descriptor.api.orm10.PreUpdate;
import org.jboss.shrinkwrap.descriptor.api.orm10.PostUpdate;
import org.jboss.shrinkwrap.descriptor.api.orm10.PostLoad;/**
* This interface defines the contract for the entity-listener xsd type
* @author Ralf Battenfeld
* @author Andrew Lee Rubinger
* @author George Gastaldi
*/
public interface EntityListener extends Child,
OrmEntityListenerCommType,
PrePersist>,
PostPersist>,
PreRemove>,
PostRemove>,
PreUpdate>,
PostUpdate>,
PostLoad>> {
// --------------------------------------------------------------------------------------------------------||
// ClassName: EntityListener 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 EntityListener
*/
public EntityListener removePrePersist();
// --------------------------------------------------------------------------------------------------------||
// ClassName: EntityListener 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 EntityListener
*/
public EntityListener removePostPersist();
// --------------------------------------------------------------------------------------------------------||
// ClassName: EntityListener 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 EntityListener
*/
public EntityListener removePreRemove();
// --------------------------------------------------------------------------------------------------------||
// ClassName: EntityListener 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 EntityListener
*/
public EntityListener removePostRemove();
// --------------------------------------------------------------------------------------------------------||
// ClassName: EntityListener 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 EntityListener
*/
public EntityListener removePreUpdate();
// --------------------------------------------------------------------------------------------------------||
// ClassName: EntityListener 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 EntityListener
*/
public EntityListener removePostUpdate();
// --------------------------------------------------------------------------------------------------------||
// ClassName: EntityListener 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 EntityListener
*/
public EntityListener removePostLoad();
// --------------------------------------------------------------------------------------------------------||
// ClassName: EntityListener 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 EntityListener
*/
public EntityListener 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 EntityListener
*/
public EntityListener removeClazzAttr();
}