org.jboss.shrinkwrap.descriptor.api.ejbjar31.MethodType 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.MethodIntfType;
import org.jboss.shrinkwrap.descriptor.api.ejbjar31.MethodParamsType;
import org.jboss.shrinkwrap.descriptor.api.ejbjar.*;
import org.jboss.shrinkwrap.descriptor.api.ejbjar.JavaeeMethodCommonType;

import org.jboss.shrinkwrap.descriptor.api.ejbjar31.MethodParamsType;/**
 * This interface defines the contract for the  methodType  xsd type 
 * @author Ralf Battenfeld
 * @author Andrew Lee Rubinger
 * @author George Gastaldi
 */
public interface MethodType extends Child, 
    JavaeeMethodCommonType,
    MethodParamsType>> { 

 
   // --------------------------------------------------------------------------------------------------------||
   // ClassName: MethodType 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 MethodType 
    */
   public MethodType description(String ... values);

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

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

 
   // --------------------------------------------------------------------------------------------------------||
   // ClassName: MethodType ElementName: javaee:xsdNMTOKENType ElementType : ejb-name
   // MaxOccurs: -  isGeneric: true   isAttribute: false isEnum: false isDataType: true
   // --------------------------------------------------------------------------------------------------------||

   /**
    * Sets the ejb-name element
    * @param ejbName the value for the element ejb-name 
    * @return the current instance of MethodType 
    */
   public MethodType ejbName(String ejbName);

   /**
    * Returns the ejb-name element
    * @return the node defined for the element ejb-name 
    */
   public String getEjbName();

   /**
    * Removes the ejb-name element 
    * @return the current instance of MethodType 
    */
   public MethodType removeEjbName();

 
   // --------------------------------------------------------------------------------------------------------||
   // ClassName: MethodType ElementName: javaee:method-intfType ElementType : method-intf
   // MaxOccurs: -  isGeneric: true   isAttribute: false isEnum: true isDataType: false
   // --------------------------------------------------------------------------------------------------------||
   /**
    * Sets the method-intf element
    * @param methodIntf the value for the element method-intf 
    * @return the current instance of MethodType 
    */
   public MethodType methodIntf(MethodIntfType methodIntf);
   /**
    * Sets the method-intf element
    * @param methodIntf the value for the element method-intf 
    * @return the current instance of MethodType 
    */
   public MethodType methodIntf(String methodIntf);

   /**
    * Returns the method-intf element
    * @return the value found for the element method-intf 
    */
   public MethodIntfType getMethodIntf();

   /**
    * Returns the method-intf element
    * @return the value found for the element method-intf 
    */
   public String  getMethodIntfAsString();

   /**
    * Removes the method-intf attribute 
    * @return the current instance of MethodType 
    */
   public MethodType removeMethodIntf();

 
   // --------------------------------------------------------------------------------------------------------||
   // ClassName: MethodType ElementName: javaee:string ElementType : method-name
   // MaxOccurs: -  isGeneric: true   isAttribute: false isEnum: false isDataType: true
   // --------------------------------------------------------------------------------------------------------||

   /**
    * Sets the method-name element
    * @param methodName the value for the element method-name 
    * @return the current instance of MethodType 
    */
   public MethodType methodName(String methodName);

   /**
    * Returns the method-name element
    * @return the node defined for the element method-name 
    */
   public String getMethodName();

   /**
    * Removes the method-name element 
    * @return the current instance of MethodType 
    */
   public MethodType removeMethodName();

 
   // --------------------------------------------------------------------------------------------------------||
   // ClassName: MethodType ElementName: javaee:method-paramsType ElementType : method-params
   // MaxOccurs: -  isGeneric: true   isAttribute: false isEnum: false isDataType: false
   // --------------------------------------------------------------------------------------------------------||

   /**
    * If not already created, a new method-params element with the given value will be created.
    * Otherwise, the existing method-params element will be returned.
    * @return  a new or existing instance of MethodParamsType> 
    */
   public MethodParamsType> getOrCreateMethodParams();

   /**
    * Removes the method-params element 
    * @return the current instance of MethodType 
    */
   public MethodType removeMethodParams();

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