org.jboss.shrinkwrap.descriptor.api.orm21.NamedEntityGraph Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of shrinkwrap-descriptors-api-javaee Show documentation
Client View of the ShrinkWrap Descriptors Project
The newest version!
package org.jboss.shrinkwrap.descriptor.api.orm21; 

import java.util.ArrayList;
import java.util.List;
import org.jboss.shrinkwrap.descriptor.api.Child;
import org.jboss.shrinkwrap.descriptor.api.orm21.NamedAttributeNode;
import org.jboss.shrinkwrap.descriptor.api.orm21.NamedSubgraph;
import org.jboss.shrinkwrap.descriptor.api.orm21.NamedSubgraph;
import org.jboss.shrinkwrap.descriptor.api.orm.*;
import org.jboss.shrinkwrap.descriptor.api.orm.OrmNamedEntityGraphCommType;

import org.jboss.shrinkwrap.descriptor.api.orm21.NamedAttributeNode;
import org.jboss.shrinkwrap.descriptor.api.orm21.NamedSubgraph;
import org.jboss.shrinkwrap.descriptor.api.orm21.NamedSubgraph;/**
 * This interface defines the contract for the  named-entity-graph  xsd type 
 * @author Ralf Battenfeld
 * @author Andrew Lee Rubinger
 */
public interface NamedEntityGraph extends Child, 
    OrmNamedEntityGraphCommType,
    NamedAttributeNode>,
    NamedSubgraph>,
    NamedSubgraph>> { 

 
   // --------------------------------------------------------------------------------------------------------||
   // ClassName: NamedEntityGraph ElementName: orm:named-attribute-node ElementType : named-attribute-node
   // MaxOccurs: -unbounded  isGeneric: true   isAttribute: false isEnum: false isDataType: false
   // --------------------------------------------------------------------------------------------------------||

   /**
    * If not already created, a new named-attribute-node element will be created and returned.
    * Otherwise, the first existing named-attribute-node element will be returned.
    * @return the instance defined for the element named-attribute-node 
    */
   public NamedAttributeNode> getOrCreateNamedAttributeNode();

   /**
    * Creates a new named-attribute-node element 
    * @return the new created instance of NamedAttributeNode> 
    */
   public NamedAttributeNode> createNamedAttributeNode();

   /**
    * Returns all named-attribute-node elements
    * @return list of named-attribute-node 
    */
   public List>> getAllNamedAttributeNode();

   /**
    * Removes all named-attribute-node elements 
    * @return the current instance of NamedAttributeNode> 
    */
   public NamedEntityGraph removeAllNamedAttributeNode();

 
   // --------------------------------------------------------------------------------------------------------||
   // ClassName: NamedEntityGraph ElementName: orm:named-subgraph ElementType : subgraph
   // MaxOccurs: -unbounded  isGeneric: true   isAttribute: false isEnum: false isDataType: false
   // --------------------------------------------------------------------------------------------------------||

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

   /**
    * Creates a new subgraph element 
    * @return the new created instance of NamedSubgraph> 
    */
   public NamedSubgraph> createSubgraph();

   /**
    * Returns all subgraph elements
    * @return list of subgraph 
    */
   public List>> getAllSubgraph();

   /**
    * Removes all subgraph elements 
    * @return the current instance of NamedSubgraph> 
    */
   public NamedEntityGraph removeAllSubgraph();

 
   // --------------------------------------------------------------------------------------------------------||
   // ClassName: NamedEntityGraph ElementName: orm:named-subgraph ElementType : subclass-subgraph
   // MaxOccurs: -unbounded  isGeneric: true   isAttribute: false isEnum: false isDataType: false
   // --------------------------------------------------------------------------------------------------------||

   /**
    * If not already created, a new subclass-subgraph element will be created and returned.
    * Otherwise, the first existing subclass-subgraph element will be returned.
    * @return the instance defined for the element subclass-subgraph 
    */
   public NamedSubgraph> getOrCreateSubclassSubgraph();

   /**
    * Creates a new subclass-subgraph element 
    * @return the new created instance of NamedSubgraph> 
    */
   public NamedSubgraph> createSubclassSubgraph();

   /**
    * Returns all subclass-subgraph elements
    * @return list of subclass-subgraph 
    */
   public List>> getAllSubclassSubgraph();

   /**
    * Removes all subclass-subgraph elements 
    * @return the current instance of NamedSubgraph> 
    */
   public NamedEntityGraph removeAllSubclassSubgraph();

 
   // --------------------------------------------------------------------------------------------------------||
   // ClassName: NamedEntityGraph ElementName: xsd:string ElementType : name
   // MaxOccurs: -  isGeneric: true   isAttribute: true isEnum: false isDataType: true
   // --------------------------------------------------------------------------------------------------------||

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

   /**
    * Returns the name attribute
    * @return the value defined for the attribute name 
    */
   public String getName();

   /**
    * Removes the name attribute 
    * @return the current instance of NamedEntityGraph 
    */
   public NamedEntityGraph removeName();

 
   // --------------------------------------------------------------------------------------------------------||
   // ClassName: NamedEntityGraph ElementName: xsd:boolean ElementType : include-all-attributes
   // MaxOccurs: -  isGeneric: true   isAttribute: true isEnum: false isDataType: true
   // --------------------------------------------------------------------------------------------------------||

   /**
    * Sets the include-all-attributes attribute
    * @param includeAllAttributes the value for the attribute include-all-attributes 
    * @return the current instance of NamedEntityGraph 
    */
   public NamedEntityGraph includeAllAttributes(Boolean includeAllAttributes);

   /**
    * Returns the include-all-attributes attribute
    * @return the value defined for the attribute include-all-attributes 
    */
public Boolean isIncludeAllAttributes();

   /**
    * Removes the include-all-attributes attribute 
    * @return the current instance of NamedEntityGraph 
    */
   public NamedEntityGraph removeIncludeAllAttributes();
}