org.jboss.shrinkwrap.descriptor.api.batchXML10.BatchXMLDescriptor Maven / Gradle / Ivy

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

import java.util.ArrayList;
import java.util.List;
import org.jboss.shrinkwrap.descriptor.api.Child;
import org.jboss.shrinkwrap.descriptor.api.batchXML10.BatchArtifactRef;
import org.jboss.shrinkwrap.descriptor.api.Descriptor;
import org.jboss.shrinkwrap.descriptor.api.DescriptorNamespace;

import org.jboss.shrinkwrap.descriptor.api.batchXML.*;
/** 
 *  
 * This deployment descriptor provides the functionalities as described in the  specification
 * 
 
 * Example:
 *  
 *  
 *     BatchXMLDescriptor descriptor = Descriptors.create(BatchXMLDescriptor.class);
 *  
 *
 *
 * @author Ralf Battenfeld
 * @author Andrew Lee Rubinger
 */
public interface BatchXMLDescriptor extends Descriptor, DescriptorNamespace, 
    BatchXMLCommonDescriptor> {

 
   // --------------------------------------------------------------------------------------------------------||
   // ClassName: BatchXMLDescriptor ElementName: jbatch:BatchArtifactRef ElementType : ref
   // MaxOccurs: -unbounded  isGeneric: false   isAttribute: false isEnum: false isDataType: false
   // --------------------------------------------------------------------------------------------------------||

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

   /**
    * Creates a new ref element 
    * @return the new created instance of BatchArtifactRef 
    */
   public BatchArtifactRef createRef();

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

   /**
    * Removes all ref elements 
    * @return the current instance of BatchArtifactRef 
    */
   public BatchXMLDescriptor removeAllRef();
}