All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.jboss.shrinkwrap.descriptor.api.ejbjar31.InterceptorType Maven / Gradle / Ivy

package org.jboss.shrinkwrap.descriptor.api.ejbjar31; 

import java.util.ArrayList;
import java.util.List;
import org.jboss.shrinkwrap.descriptor.api.Child;
import org.jboss.shrinkwrap.descriptor.api.ejbjar31.AroundInvokeType;
import org.jboss.shrinkwrap.descriptor.api.ejbjar31.AroundTimeoutType;
import org.jboss.shrinkwrap.descriptor.api.javaee6.LifecycleCallbackType;
import org.jboss.shrinkwrap.descriptor.api.javaee6.LifecycleCallbackType;
import org.jboss.shrinkwrap.descriptor.api.javaee6.EnvEntryType;
import org.jboss.shrinkwrap.descriptor.api.javaee6.EjbRefType;
import org.jboss.shrinkwrap.descriptor.api.javaee6.EjbLocalRefType;
import org.jboss.shrinkwrap.descriptor.api.javaee6.ResourceRefType;
import org.jboss.shrinkwrap.descriptor.api.javaee6.ResourceEnvRefType;
import org.jboss.shrinkwrap.descriptor.api.javaee6.MessageDestinationRefType;
import org.jboss.shrinkwrap.descriptor.api.javaee6.PersistenceContextRefType;
import org.jboss.shrinkwrap.descriptor.api.javaee6.PersistenceUnitRefType;
import org.jboss.shrinkwrap.descriptor.api.javaee6.LifecycleCallbackType;
import org.jboss.shrinkwrap.descriptor.api.javaee6.LifecycleCallbackType;
import org.jboss.shrinkwrap.descriptor.api.javaee6.DataSourceType;
import org.jboss.shrinkwrap.descriptor.api.javaeewebservicesclient13.ServiceRefType;
import org.jboss.shrinkwrap.descriptor.api.ejbjar.*;
import org.jboss.shrinkwrap.descriptor.api.ejbjar.JavaeeInterceptorCommonType;

import org.jboss.shrinkwrap.descriptor.api.ejbjar31.AroundInvokeType;
import org.jboss.shrinkwrap.descriptor.api.javaee6.LifecycleCallbackType;
import org.jboss.shrinkwrap.descriptor.api.javaee6.LifecycleCallbackType;/**
 * This interface defines the contract for the  interceptorType  xsd type 
 * @author Ralf Battenfeld
 * @author Andrew Lee Rubinger
 * @author George Gastaldi
 */
public interface InterceptorType extends Child, 
    JavaeeInterceptorCommonType,
    AroundInvokeType>,
    LifecycleCallbackType>,
    LifecycleCallbackType>> { 

 
   // --------------------------------------------------------------------------------------------------------||
   // ClassName: InterceptorType ElementName: javaee:env-entryType ElementType : env-entry
   // MaxOccurs: -unbounded  isGeneric: true   isAttribute: false isEnum: false isDataType: false
   // --------------------------------------------------------------------------------------------------------||

   /**
    * If not already created, a new env-entry element will be created and returned.
    * Otherwise, the first existing env-entry element will be returned.
    * @return the instance defined for the element env-entry 
    */
   public EnvEntryType> getOrCreateEnvEntry();

   /**
    * Creates a new env-entry element 
    * @return the new created instance of EnvEntryType> 
    */
   public EnvEntryType> createEnvEntry();

   /**
    * Returns all env-entry elements
    * @return list of env-entry 
    */
   public List>> getAllEnvEntry();

   /**
    * Removes all env-entry elements 
    * @return the current instance of EnvEntryType> 
    */
   public InterceptorType removeAllEnvEntry();
 
   // --------------------------------------------------------------------------------------------------------||
   // ClassName: InterceptorType ElementName: javaee:ejb-refType ElementType : ejb-ref
   // MaxOccurs: -unbounded  isGeneric: true   isAttribute: false isEnum: false isDataType: false
   // --------------------------------------------------------------------------------------------------------||

   /**
    * If not already created, a new ejb-ref element will be created and returned.
    * Otherwise, the first existing ejb-ref element will be returned.
    * @return the instance defined for the element ejb-ref 
    */
   public EjbRefType> getOrCreateEjbRef();

   /**
    * Creates a new ejb-ref element 
    * @return the new created instance of EjbRefType> 
    */
   public EjbRefType> createEjbRef();

   /**
    * Returns all ejb-ref elements
    * @return list of ejb-ref 
    */
   public List>> getAllEjbRef();

   /**
    * Removes all ejb-ref elements 
    * @return the current instance of EjbRefType> 
    */
   public InterceptorType removeAllEjbRef();
 
   // --------------------------------------------------------------------------------------------------------||
   // ClassName: InterceptorType ElementName: javaee:ejb-local-refType ElementType : ejb-local-ref
   // MaxOccurs: -unbounded  isGeneric: true   isAttribute: false isEnum: false isDataType: false
   // --------------------------------------------------------------------------------------------------------||

   /**
    * If not already created, a new ejb-local-ref element will be created and returned.
    * Otherwise, the first existing ejb-local-ref element will be returned.
    * @return the instance defined for the element ejb-local-ref 
    */
   public EjbLocalRefType> getOrCreateEjbLocalRef();

   /**
    * Creates a new ejb-local-ref element 
    * @return the new created instance of EjbLocalRefType> 
    */
   public EjbLocalRefType> createEjbLocalRef();

   /**
    * Returns all ejb-local-ref elements
    * @return list of ejb-local-ref 
    */
   public List>> getAllEjbLocalRef();

   /**
    * Removes all ejb-local-ref elements 
    * @return the current instance of EjbLocalRefType> 
    */
   public InterceptorType removeAllEjbLocalRef();
 
   // --------------------------------------------------------------------------------------------------------||
   // ClassName: InterceptorType ElementName: javaee:resource-refType ElementType : resource-ref
   // MaxOccurs: -unbounded  isGeneric: true   isAttribute: false isEnum: false isDataType: false
   // --------------------------------------------------------------------------------------------------------||

   /**
    * If not already created, a new resource-ref element will be created and returned.
    * Otherwise, the first existing resource-ref element will be returned.
    * @return the instance defined for the element resource-ref 
    */
   public ResourceRefType> getOrCreateResourceRef();

   /**
    * Creates a new resource-ref element 
    * @return the new created instance of ResourceRefType> 
    */
   public ResourceRefType> createResourceRef();

   /**
    * Returns all resource-ref elements
    * @return list of resource-ref 
    */
   public List>> getAllResourceRef();

   /**
    * Removes all resource-ref elements 
    * @return the current instance of ResourceRefType> 
    */
   public InterceptorType removeAllResourceRef();
 
   // --------------------------------------------------------------------------------------------------------||
   // ClassName: InterceptorType ElementName: javaee:resource-env-refType ElementType : resource-env-ref
   // MaxOccurs: -unbounded  isGeneric: true   isAttribute: false isEnum: false isDataType: false
   // --------------------------------------------------------------------------------------------------------||

   /**
    * If not already created, a new resource-env-ref element will be created and returned.
    * Otherwise, the first existing resource-env-ref element will be returned.
    * @return the instance defined for the element resource-env-ref 
    */
   public ResourceEnvRefType> getOrCreateResourceEnvRef();

   /**
    * Creates a new resource-env-ref element 
    * @return the new created instance of ResourceEnvRefType> 
    */
   public ResourceEnvRefType> createResourceEnvRef();

   /**
    * Returns all resource-env-ref elements
    * @return list of resource-env-ref 
    */
   public List>> getAllResourceEnvRef();

   /**
    * Removes all resource-env-ref elements 
    * @return the current instance of ResourceEnvRefType> 
    */
   public InterceptorType removeAllResourceEnvRef();
 
   // --------------------------------------------------------------------------------------------------------||
   // ClassName: InterceptorType ElementName: javaee:message-destination-refType ElementType : message-destination-ref
   // MaxOccurs: -unbounded  isGeneric: true   isAttribute: false isEnum: false isDataType: false
   // --------------------------------------------------------------------------------------------------------||

   /**
    * If not already created, a new message-destination-ref element will be created and returned.
    * Otherwise, the first existing message-destination-ref element will be returned.
    * @return the instance defined for the element message-destination-ref 
    */
   public MessageDestinationRefType> getOrCreateMessageDestinationRef();

   /**
    * Creates a new message-destination-ref element 
    * @return the new created instance of MessageDestinationRefType> 
    */
   public MessageDestinationRefType> createMessageDestinationRef();

   /**
    * Returns all message-destination-ref elements
    * @return list of message-destination-ref 
    */
   public List>> getAllMessageDestinationRef();

   /**
    * Removes all message-destination-ref elements 
    * @return the current instance of MessageDestinationRefType> 
    */
   public InterceptorType removeAllMessageDestinationRef();
 
   // --------------------------------------------------------------------------------------------------------||
   // ClassName: InterceptorType ElementName: javaee:persistence-context-refType ElementType : persistence-context-ref
   // MaxOccurs: -unbounded  isGeneric: true   isAttribute: false isEnum: false isDataType: false
   // --------------------------------------------------------------------------------------------------------||

   /**
    * If not already created, a new persistence-context-ref element will be created and returned.
    * Otherwise, the first existing persistence-context-ref element will be returned.
    * @return the instance defined for the element persistence-context-ref 
    */
   public PersistenceContextRefType> getOrCreatePersistenceContextRef();

   /**
    * Creates a new persistence-context-ref element 
    * @return the new created instance of PersistenceContextRefType> 
    */
   public PersistenceContextRefType> createPersistenceContextRef();

   /**
    * Returns all persistence-context-ref elements
    * @return list of persistence-context-ref 
    */
   public List>> getAllPersistenceContextRef();

   /**
    * Removes all persistence-context-ref elements 
    * @return the current instance of PersistenceContextRefType> 
    */
   public InterceptorType removeAllPersistenceContextRef();
 
   // --------------------------------------------------------------------------------------------------------||
   // ClassName: InterceptorType ElementName: javaee:persistence-unit-refType ElementType : persistence-unit-ref
   // MaxOccurs: -unbounded  isGeneric: true   isAttribute: false isEnum: false isDataType: false
   // --------------------------------------------------------------------------------------------------------||

   /**
    * If not already created, a new persistence-unit-ref element will be created and returned.
    * Otherwise, the first existing persistence-unit-ref element will be returned.
    * @return the instance defined for the element persistence-unit-ref 
    */
   public PersistenceUnitRefType> getOrCreatePersistenceUnitRef();

   /**
    * Creates a new persistence-unit-ref element 
    * @return the new created instance of PersistenceUnitRefType> 
    */
   public PersistenceUnitRefType> createPersistenceUnitRef();

   /**
    * Returns all persistence-unit-ref elements
    * @return list of persistence-unit-ref 
    */
   public List>> getAllPersistenceUnitRef();

   /**
    * Removes all persistence-unit-ref elements 
    * @return the current instance of PersistenceUnitRefType> 
    */
   public InterceptorType removeAllPersistenceUnitRef();
 
   // --------------------------------------------------------------------------------------------------------||
   // ClassName: InterceptorType ElementName: javaee:lifecycle-callbackType ElementType : post-construct
   // MaxOccurs: -unbounded  isGeneric: true   isAttribute: false isEnum: false isDataType: false
   // --------------------------------------------------------------------------------------------------------||

   /**
    * If not already created, a new post-construct element will be created and returned.
    * Otherwise, the first existing post-construct element will be returned.
    * @return the instance defined for the element post-construct 
    */
   public LifecycleCallbackType> getOrCreatePostConstruct();

   /**
    * Creates a new post-construct element 
    * @return the new created instance of LifecycleCallbackType> 
    */
   public LifecycleCallbackType> createPostConstruct();

   /**
    * Returns all post-construct elements
    * @return list of post-construct 
    */
   public List>> getAllPostConstruct();

   /**
    * Removes all post-construct elements 
    * @return the current instance of LifecycleCallbackType> 
    */
   public InterceptorType removeAllPostConstruct();
 
   // --------------------------------------------------------------------------------------------------------||
   // ClassName: InterceptorType ElementName: javaee:lifecycle-callbackType ElementType : pre-destroy
   // MaxOccurs: -unbounded  isGeneric: true   isAttribute: false isEnum: false isDataType: false
   // --------------------------------------------------------------------------------------------------------||

   /**
    * If not already created, a new pre-destroy element will be created and returned.
    * Otherwise, the first existing pre-destroy element will be returned.
    * @return the instance defined for the element pre-destroy 
    */
   public LifecycleCallbackType> getOrCreatePreDestroy();

   /**
    * Creates a new pre-destroy element 
    * @return the new created instance of LifecycleCallbackType> 
    */
   public LifecycleCallbackType> createPreDestroy();

   /**
    * Returns all pre-destroy elements
    * @return list of pre-destroy 
    */
   public List>> getAllPreDestroy();

   /**
    * Removes all pre-destroy elements 
    * @return the current instance of LifecycleCallbackType> 
    */
   public InterceptorType removeAllPreDestroy();
 
   // --------------------------------------------------------------------------------------------------------||
   // ClassName: InterceptorType ElementName: javaee:data-sourceType ElementType : data-source
   // MaxOccurs: -unbounded  isGeneric: true   isAttribute: false isEnum: false isDataType: false
   // --------------------------------------------------------------------------------------------------------||

   /**
    * If not already created, a new data-source element will be created and returned.
    * Otherwise, the first existing data-source element will be returned.
    * @return the instance defined for the element data-source 
    */
   public DataSourceType> getOrCreateDataSource();

   /**
    * Creates a new data-source element 
    * @return the new created instance of DataSourceType> 
    */
   public DataSourceType> createDataSource();

   /**
    * Returns all data-source elements
    * @return list of data-source 
    */
   public List>> getAllDataSource();

   /**
    * Removes all data-source elements 
    * @return the current instance of DataSourceType> 
    */
   public InterceptorType removeAllDataSource();
 
   // --------------------------------------------------------------------------------------------------------||
   // ClassName: InterceptorType ElementName: javaee:service-refType ElementType : service-ref
   // MaxOccurs: -unbounded  isGeneric: true   isAttribute: false isEnum: false isDataType: false
   // --------------------------------------------------------------------------------------------------------||

   /**
    * If not already created, a new service-ref element will be created and returned.
    * Otherwise, the first existing service-ref element will be returned.
    * @return the instance defined for the element service-ref 
    */
   public ServiceRefType> getOrCreateServiceRef();

   /**
    * Creates a new service-ref element 
    * @return the new created instance of ServiceRefType> 
    */
   public ServiceRefType> createServiceRef();

   /**
    * Returns all service-ref elements
    * @return list of service-ref 
    */
   public List>> getAllServiceRef();

   /**
    * Removes all service-ref elements 
    * @return the current instance of ServiceRefType> 
    */
   public InterceptorType removeAllServiceRef();
 
   // --------------------------------------------------------------------------------------------------------||
   // ClassName: InterceptorType ElementName: xsd:string ElementType : description
   // MaxOccurs: -unbounded  isGeneric: true   isAttribute: false isEnum: false isDataType: true
   // --------------------------------------------------------------------------------------------------------||

   /**
    * Creates for all String objects representing description elements, 
    * a new description element 
    * @param values list of description objects 
    * @return the current instance of InterceptorType 
    */
   public InterceptorType description(String ... values);

   /**
    * Returns all description elements
    * @return list of description 
    */
   public List getAllDescription();

   /**
    * Removes the description element 
    * @return the current instance of InterceptorType 
    */
   public InterceptorType removeAllDescription();

 
   // --------------------------------------------------------------------------------------------------------||
   // ClassName: InterceptorType ElementName: xsd:token ElementType : interceptor-class
   // MaxOccurs: -  isGeneric: true   isAttribute: false isEnum: false isDataType: true
   // --------------------------------------------------------------------------------------------------------||

   /**
    * Sets the interceptor-class element
    * @param interceptorClass the value for the element interceptor-class 
    * @return the current instance of InterceptorType 
    */
   public InterceptorType interceptorClass(String interceptorClass);

   /**
    * Returns the interceptor-class element
    * @return the node defined for the element interceptor-class 
    */
   public String getInterceptorClass();

   /**
    * Removes the interceptor-class element 
    * @return the current instance of InterceptorType 
    */
   public InterceptorType removeInterceptorClass();

 
   // --------------------------------------------------------------------------------------------------------||
   // ClassName: InterceptorType ElementName: javaee:around-invokeType ElementType : around-invoke
   // MaxOccurs: -unbounded  isGeneric: true   isAttribute: false isEnum: false isDataType: false
   // --------------------------------------------------------------------------------------------------------||

   /**
    * If not already created, a new around-invoke element will be created and returned.
    * Otherwise, the first existing around-invoke element will be returned.
    * @return the instance defined for the element around-invoke 
    */
   public AroundInvokeType> getOrCreateAroundInvoke();

   /**
    * Creates a new around-invoke element 
    * @return the new created instance of AroundInvokeType> 
    */
   public AroundInvokeType> createAroundInvoke();

   /**
    * Returns all around-invoke elements
    * @return list of around-invoke 
    */
   public List>> getAllAroundInvoke();

   /**
    * Removes all around-invoke elements 
    * @return the current instance of AroundInvokeType> 
    */
   public InterceptorType removeAllAroundInvoke();

 
   // --------------------------------------------------------------------------------------------------------||
   // ClassName: InterceptorType ElementName: javaee:around-timeoutType ElementType : around-timeout
   // MaxOccurs: -unbounded  isGeneric: true   isAttribute: false isEnum: false isDataType: false
   // --------------------------------------------------------------------------------------------------------||

   /**
    * If not already created, a new around-timeout element will be created and returned.
    * Otherwise, the first existing around-timeout element will be returned.
    * @return the instance defined for the element around-timeout 
    */
   public AroundTimeoutType> getOrCreateAroundTimeout();

   /**
    * Creates a new around-timeout element 
    * @return the new created instance of AroundTimeoutType> 
    */
   public AroundTimeoutType> createAroundTimeout();

   /**
    * Returns all around-timeout elements
    * @return list of around-timeout 
    */
   public List>> getAllAroundTimeout();

   /**
    * Removes all around-timeout elements 
    * @return the current instance of AroundTimeoutType> 
    */
   public InterceptorType removeAllAroundTimeout();

 
   // --------------------------------------------------------------------------------------------------------||
   // ClassName: InterceptorType ElementName: javaee:lifecycle-callbackType ElementType : post-activate
   // MaxOccurs: -unbounded  isGeneric: true   isAttribute: false isEnum: false isDataType: false
   // --------------------------------------------------------------------------------------------------------||

   /**
    * If not already created, a new post-activate element will be created and returned.
    * Otherwise, the first existing post-activate element will be returned.
    * @return the instance defined for the element post-activate 
    */
   public LifecycleCallbackType> getOrCreatePostActivate();

   /**
    * Creates a new post-activate element 
    * @return the new created instance of LifecycleCallbackType> 
    */
   public LifecycleCallbackType> createPostActivate();

   /**
    * Returns all post-activate elements
    * @return list of post-activate 
    */
   public List>> getAllPostActivate();

   /**
    * Removes all post-activate elements 
    * @return the current instance of LifecycleCallbackType> 
    */
   public InterceptorType removeAllPostActivate();

 
   // --------------------------------------------------------------------------------------------------------||
   // ClassName: InterceptorType ElementName: javaee:lifecycle-callbackType ElementType : pre-passivate
   // MaxOccurs: -unbounded  isGeneric: true   isAttribute: false isEnum: false isDataType: false
   // --------------------------------------------------------------------------------------------------------||

   /**
    * If not already created, a new pre-passivate element will be created and returned.
    * Otherwise, the first existing pre-passivate element will be returned.
    * @return the instance defined for the element pre-passivate 
    */
   public LifecycleCallbackType> getOrCreatePrePassivate();

   /**
    * Creates a new pre-passivate element 
    * @return the new created instance of LifecycleCallbackType> 
    */
   public LifecycleCallbackType> createPrePassivate();

   /**
    * Returns all pre-passivate elements
    * @return list of pre-passivate 
    */
   public List>> getAllPrePassivate();

   /**
    * Removes all pre-passivate elements 
    * @return the current instance of LifecycleCallbackType> 
    */
   public InterceptorType removeAllPrePassivate();

 
   // --------------------------------------------------------------------------------------------------------||
   // ClassName: InterceptorType ElementName: xsd:ID ElementType : id
   // MaxOccurs: -  isGeneric: true   isAttribute: true isEnum: false isDataType: true
   // --------------------------------------------------------------------------------------------------------||

   /**
    * Sets the id attribute
    * @param id the value for the attribute id 
    * @return the current instance of InterceptorType 
    */
   public InterceptorType id(String id);

   /**
    * Returns the id attribute
    * @return the value defined for the attribute id 
    */
   public String getId();

   /**
    * Removes the id attribute 
    * @return the current instance of InterceptorType 
    */
   public InterceptorType removeId();
}




© 2015 - 2024 Weber Informatics LLC | Privacy Policy