org.jboss.shrinkwrap.descriptor.api.ejbjar32.EjbRelationshipRoleType Maven / Gradle / Ivy

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

import java.util.ArrayList;
import java.util.List;
import org.jboss.shrinkwrap.descriptor.api.Child;
import org.jboss.shrinkwrap.descriptor.api.ejbjar32.MultiplicityType;
import org.jboss.shrinkwrap.descriptor.api.ejbjar32.RelationshipRoleSourceType;
import org.jboss.shrinkwrap.descriptor.api.ejbjar32.CmrFieldType;
import org.jboss.shrinkwrap.descriptor.api.ejbjar.*;
import org.jboss.shrinkwrap.descriptor.api.ejbjar.JavaeeEjbRelationshipRoleCommonType;

import org.jboss.shrinkwrap.descriptor.api.ejbjar32.RelationshipRoleSourceType;
import org.jboss.shrinkwrap.descriptor.api.ejbjar32.CmrFieldType;/**
 * This interface defines the contract for the  ejb-relationship-roleType  xsd type 
 * @author Ralf Battenfeld
 * @author Andrew Lee Rubinger
 */
public interface EjbRelationshipRoleType extends Child, 
    JavaeeEjbRelationshipRoleCommonType,
    RelationshipRoleSourceType>,
    CmrFieldType>> { 

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

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

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

 
   // --------------------------------------------------------------------------------------------------------||
   // ClassName: EjbRelationshipRoleType ElementName: xsd:token ElementType : ejb-relationship-role-name
   // MaxOccurs: -  isGeneric: true   isAttribute: false isEnum: false isDataType: true
   // --------------------------------------------------------------------------------------------------------||

   /**
    * Sets the ejb-relationship-role-name element
    * @param ejbRelationshipRoleName the value for the element ejb-relationship-role-name 
    * @return the current instance of EjbRelationshipRoleType 
    */
   public EjbRelationshipRoleType ejbRelationshipRoleName(String ejbRelationshipRoleName);

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

   /**
    * Removes the ejb-relationship-role-name element 
    * @return the current instance of EjbRelationshipRoleType 
    */
   public EjbRelationshipRoleType removeEjbRelationshipRoleName();

 
   // --------------------------------------------------------------------------------------------------------||
   // ClassName: EjbRelationshipRoleType ElementName: javaee:multiplicityType ElementType : multiplicity
   // MaxOccurs: -  isGeneric: true   isAttribute: false isEnum: true isDataType: false
   // --------------------------------------------------------------------------------------------------------||
   /**
    * Sets the multiplicity element
    * @param multiplicity the value for the element multiplicity 
    * @return the current instance of EjbRelationshipRoleType 
    */
   public EjbRelationshipRoleType multiplicity(MultiplicityType multiplicity);
   /**
    * Sets the multiplicity element
    * @param multiplicity the value for the element multiplicity 
    * @return the current instance of EjbRelationshipRoleType 
    */
   public EjbRelationshipRoleType multiplicity(String multiplicity);

   /**
    * Returns the multiplicity element
    * @return the value found for the element multiplicity 
    */
   public MultiplicityType getMultiplicity();

   /**
    * Returns the multiplicity element
    * @return the value found for the element multiplicity 
    */
   public String  getMultiplicityAsString();

   /**
    * Removes the multiplicity attribute 
    * @return the current instance of EjbRelationshipRoleType 
    */
   public EjbRelationshipRoleType removeMultiplicity();

 
   // --------------------------------------------------------------------------------------------------------||
   // ClassName: EjbRelationshipRoleType ElementName: javaee:emptyType ElementType : cascade-delete
   // MaxOccurs: -  isGeneric: true   isAttribute: false isEnum: false isDataType: true
   // --------------------------------------------------------------------------------------------------------||

   /**
    * Sets the cascade-delete element 
    * @return the current instance of EjbRelationshipRoleType 
    */
   public EjbRelationshipRoleType cascadeDelete();

   /**
    * Removes the cascade-delete element 
    * @return the current instance of EjbRelationshipRoleType 
    */
   public Boolean isCascadeDelete();

   /**
    * Removes the cascade-delete element 
    * @return the current instance of EjbRelationshipRoleType 
    */
   public EjbRelationshipRoleType removeCascadeDelete();

 
   // --------------------------------------------------------------------------------------------------------||
   // ClassName: EjbRelationshipRoleType ElementName: javaee:relationship-role-sourceType ElementType : relationship-role-source
   // MaxOccurs: -  isGeneric: true   isAttribute: false isEnum: false isDataType: false
   // --------------------------------------------------------------------------------------------------------||

   /**
    * If not already created, a new relationship-role-source element with the given value will be created.
    * Otherwise, the existing relationship-role-source element will be returned.
    * @return  a new or existing instance of RelationshipRoleSourceType> 
    */
   public RelationshipRoleSourceType> getOrCreateRelationshipRoleSource();

   /**
    * Removes the relationship-role-source element 
    * @return the current instance of EjbRelationshipRoleType 
    */
   public EjbRelationshipRoleType removeRelationshipRoleSource();

 
   // --------------------------------------------------------------------------------------------------------||
   // ClassName: EjbRelationshipRoleType ElementName: javaee:cmr-fieldType ElementType : cmr-field
   // MaxOccurs: -  isGeneric: true   isAttribute: false isEnum: false isDataType: false
   // --------------------------------------------------------------------------------------------------------||

   /**
    * If not already created, a new cmr-field element with the given value will be created.
    * Otherwise, the existing cmr-field element will be returned.
    * @return  a new or existing instance of CmrFieldType> 
    */
   public CmrFieldType> getOrCreateCmrField();

   /**
    * Removes the cmr-field element 
    * @return the current instance of EjbRelationshipRoleType 
    */
   public EjbRelationshipRoleType removeCmrField();

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