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

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

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.OrderColumn;
import org.jboss.shrinkwrap.descriptor.api.orm21.MapKey;
import org.jboss.shrinkwrap.descriptor.api.orm21.MapKeyClass;
import org.jboss.shrinkwrap.descriptor.api.orm21.TemporalType;
import org.jboss.shrinkwrap.descriptor.api.orm21.EnumType;
import org.jboss.shrinkwrap.descriptor.api.orm21.AttributeOverride;
import org.jboss.shrinkwrap.descriptor.api.orm21.Convert;
import org.jboss.shrinkwrap.descriptor.api.orm21.MapKeyColumn;
import org.jboss.shrinkwrap.descriptor.api.orm21.MapKeyJoinColumn;
import org.jboss.shrinkwrap.descriptor.api.orm21.ForeignKey;
import org.jboss.shrinkwrap.descriptor.api.orm21.Column;
import org.jboss.shrinkwrap.descriptor.api.orm21.TemporalType;
import org.jboss.shrinkwrap.descriptor.api.orm21.EnumType;
import org.jboss.shrinkwrap.descriptor.api.orm21.AttributeOverride;
import org.jboss.shrinkwrap.descriptor.api.orm21.AssociationOverride;
import org.jboss.shrinkwrap.descriptor.api.orm21.Convert;
import org.jboss.shrinkwrap.descriptor.api.orm21.CollectionTable;
import org.jboss.shrinkwrap.descriptor.api.orm21.FetchType;
import org.jboss.shrinkwrap.descriptor.api.orm21.AccessType;
import org.jboss.shrinkwrap.descriptor.api.orm.*;
import org.jboss.shrinkwrap.descriptor.api.orm.OrmElementCollectionCommType;

import org.jboss.shrinkwrap.descriptor.api.orm21.OrderColumn;
import org.jboss.shrinkwrap.descriptor.api.orm21.MapKey;
import org.jboss.shrinkwrap.descriptor.api.orm21.MapKeyClass;
import org.jboss.shrinkwrap.descriptor.api.orm21.AttributeOverride;
import org.jboss.shrinkwrap.descriptor.api.orm21.MapKeyColumn;
import org.jboss.shrinkwrap.descriptor.api.orm21.MapKeyJoinColumn;
import org.jboss.shrinkwrap.descriptor.api.orm21.Column;
import org.jboss.shrinkwrap.descriptor.api.orm21.AttributeOverride;
import org.jboss.shrinkwrap.descriptor.api.orm21.AssociationOverride;
import org.jboss.shrinkwrap.descriptor.api.orm21.CollectionTable;/**
 * This interface defines the contract for the  element-collection  xsd type 
 * @author Ralf Battenfeld
 * @author Andrew Lee Rubinger
 */
public interface ElementCollection extends Child, 
    OrmElementCollectionCommType,
    OrderColumn>,
    MapKey>,
    MapKeyClass>,
    AttributeOverride>,
    MapKeyColumn>,
    MapKeyJoinColumn>,
    Column>,
    AttributeOverride>,
    AssociationOverride>,
    CollectionTable>> { 

 
   // --------------------------------------------------------------------------------------------------------||
   // ClassName: ElementCollection ElementName: xsd:string ElementType : order-by
   // MaxOccurs: -  isGeneric: true   isAttribute: false isEnum: false isDataType: true
   // --------------------------------------------------------------------------------------------------------||

   /**
    * Sets the order-by element
    * @param orderBy the value for the element order-by 
    * @return the current instance of ElementCollection 
    */
   public ElementCollection orderBy(String orderBy);

   /**
    * Returns the order-by element
    * @return the node defined for the element order-by 
    */
   public String getOrderBy();

   /**
    * Removes the order-by element 
    * @return the current instance of ElementCollection 
    */
   public ElementCollection removeOrderBy();

 
   // --------------------------------------------------------------------------------------------------------||
   // ClassName: ElementCollection ElementName: orm:order-column ElementType : order-column
   // MaxOccurs: -  isGeneric: true   isAttribute: false isEnum: false isDataType: false
   // --------------------------------------------------------------------------------------------------------||

   /**
    * If not already created, a new order-column element with the given value will be created.
    * Otherwise, the existing order-column element will be returned.
    * @return  a new or existing instance of OrderColumn> 
    */
   public OrderColumn> getOrCreateOrderColumn();

   /**
    * Removes the order-column element 
    * @return the current instance of ElementCollection 
    */
   public ElementCollection removeOrderColumn();

 
   // --------------------------------------------------------------------------------------------------------||
   // ClassName: ElementCollection ElementName: orm:map-key ElementType : map-key
   // MaxOccurs: -  isGeneric: true   isAttribute: false isEnum: false isDataType: false
   // --------------------------------------------------------------------------------------------------------||

   /**
    * If not already created, a new map-key element with the given value will be created.
    * Otherwise, the existing map-key element will be returned.
    * @return  a new or existing instance of MapKey> 
    */
   public MapKey> getOrCreateMapKey();

   /**
    * Removes the map-key element 
    * @return the current instance of ElementCollection 
    */
   public ElementCollection removeMapKey();

 
   // --------------------------------------------------------------------------------------------------------||
   // ClassName: ElementCollection ElementName: orm:map-key-class ElementType : map-key-class
   // MaxOccurs: -  isGeneric: true   isAttribute: false isEnum: false isDataType: false
   // --------------------------------------------------------------------------------------------------------||

   /**
    * If not already created, a new map-key-class element with the given value will be created.
    * Otherwise, the existing map-key-class element will be returned.
    * @return  a new or existing instance of MapKeyClass> 
    */
   public MapKeyClass> getOrCreateMapKeyClass();

   /**
    * Removes the map-key-class element 
    * @return the current instance of ElementCollection 
    */
   public ElementCollection removeMapKeyClass();

 
   // --------------------------------------------------------------------------------------------------------||
   // ClassName: ElementCollection ElementName: orm:temporal-type ElementType : map-key-temporal
   // MaxOccurs: -  isGeneric: true   isAttribute: false isEnum: true isDataType: false
   // --------------------------------------------------------------------------------------------------------||
   /**
    * Sets the map-key-temporal element
    * @param mapKeyTemporal the value for the element map-key-temporal 
    * @return the current instance of ElementCollection 
    */
   public ElementCollection mapKeyTemporal(TemporalType mapKeyTemporal);
   /**
    * Sets the map-key-temporal element
    * @param mapKeyTemporal the value for the element map-key-temporal 
    * @return the current instance of ElementCollection 
    */
   public ElementCollection mapKeyTemporal(String mapKeyTemporal);

   /**
    * Returns the map-key-temporal element
    * @return the value found for the element map-key-temporal 
    */
   public TemporalType getMapKeyTemporal();

   /**
    * Returns the map-key-temporal element
    * @return the value found for the element map-key-temporal 
    */
   public String  getMapKeyTemporalAsString();

   /**
    * Removes the map-key-temporal attribute 
    * @return the current instance of ElementCollection 
    */
   public ElementCollection removeMapKeyTemporal();

 
   // --------------------------------------------------------------------------------------------------------||
   // ClassName: ElementCollection ElementName: orm:enum-type ElementType : map-key-enumerated
   // MaxOccurs: -  isGeneric: true   isAttribute: false isEnum: true isDataType: false
   // --------------------------------------------------------------------------------------------------------||
   /**
    * Sets the map-key-enumerated element
    * @param mapKeyEnumerated the value for the element map-key-enumerated 
    * @return the current instance of ElementCollection 
    */
   public ElementCollection mapKeyEnumerated(EnumType mapKeyEnumerated);
   /**
    * Sets the map-key-enumerated element
    * @param mapKeyEnumerated the value for the element map-key-enumerated 
    * @return the current instance of ElementCollection 
    */
   public ElementCollection mapKeyEnumerated(String mapKeyEnumerated);

   /**
    * Returns the map-key-enumerated element
    * @return the value found for the element map-key-enumerated 
    */
   public EnumType getMapKeyEnumerated();

   /**
    * Returns the map-key-enumerated element
    * @return the value found for the element map-key-enumerated 
    */
   public String  getMapKeyEnumeratedAsString();

   /**
    * Removes the map-key-enumerated attribute 
    * @return the current instance of ElementCollection 
    */
   public ElementCollection removeMapKeyEnumerated();

 
   // --------------------------------------------------------------------------------------------------------||
   // ClassName: ElementCollection ElementName: orm:attribute-override ElementType : map-key-attribute-override
   // MaxOccurs: -unbounded  isGeneric: true   isAttribute: false isEnum: false isDataType: false
   // --------------------------------------------------------------------------------------------------------||

   /**
    * If not already created, a new map-key-attribute-override element will be created and returned.
    * Otherwise, the first existing map-key-attribute-override element will be returned.
    * @return the instance defined for the element map-key-attribute-override 
    */
   public AttributeOverride> getOrCreateMapKeyAttributeOverride();

   /**
    * Creates a new map-key-attribute-override element 
    * @return the new created instance of AttributeOverride> 
    */
   public AttributeOverride> createMapKeyAttributeOverride();

   /**
    * Returns all map-key-attribute-override elements
    * @return list of map-key-attribute-override 
    */
   public List>> getAllMapKeyAttributeOverride();

   /**
    * Removes all map-key-attribute-override elements 
    * @return the current instance of AttributeOverride> 
    */
   public ElementCollection removeAllMapKeyAttributeOverride();

 
   // --------------------------------------------------------------------------------------------------------||
   // ClassName: ElementCollection ElementName: orm:convert ElementType : map-key-convert
   // MaxOccurs: -unbounded  isGeneric: true   isAttribute: false isEnum: false isDataType: false
   // --------------------------------------------------------------------------------------------------------||

   /**
    * If not already created, a new map-key-convert element will be created and returned.
    * Otherwise, the first existing map-key-convert element will be returned.
    * @return the instance defined for the element map-key-convert 
    */
   public Convert> getOrCreateMapKeyConvert();

   /**
    * Creates a new map-key-convert element 
    * @return the new created instance of Convert> 
    */
   public Convert> createMapKeyConvert();

   /**
    * Returns all map-key-convert elements
    * @return list of map-key-convert 
    */
   public List>> getAllMapKeyConvert();

   /**
    * Removes all map-key-convert elements 
    * @return the current instance of Convert> 
    */
   public ElementCollection removeAllMapKeyConvert();

 
   // --------------------------------------------------------------------------------------------------------||
   // ClassName: ElementCollection ElementName: orm:map-key-column ElementType : map-key-column
   // MaxOccurs: -  isGeneric: true   isAttribute: false isEnum: false isDataType: false
   // --------------------------------------------------------------------------------------------------------||

   /**
    * If not already created, a new map-key-column element with the given value will be created.
    * Otherwise, the existing map-key-column element will be returned.
    * @return  a new or existing instance of MapKeyColumn> 
    */
   public MapKeyColumn> getOrCreateMapKeyColumn();

   /**
    * Removes the map-key-column element 
    * @return the current instance of ElementCollection 
    */
   public ElementCollection removeMapKeyColumn();

 
   // --------------------------------------------------------------------------------------------------------||
   // ClassName: ElementCollection ElementName: orm:map-key-join-column ElementType : map-key-join-column
   // MaxOccurs: -unbounded  isGeneric: true   isAttribute: false isEnum: false isDataType: false
   // --------------------------------------------------------------------------------------------------------||

   /**
    * If not already created, a new map-key-join-column element will be created and returned.
    * Otherwise, the first existing map-key-join-column element will be returned.
    * @return the instance defined for the element map-key-join-column 
    */
   public MapKeyJoinColumn> getOrCreateMapKeyJoinColumn();

   /**
    * Creates a new map-key-join-column element 
    * @return the new created instance of MapKeyJoinColumn> 
    */
   public MapKeyJoinColumn> createMapKeyJoinColumn();

   /**
    * Returns all map-key-join-column elements
    * @return list of map-key-join-column 
    */
   public List>> getAllMapKeyJoinColumn();

   /**
    * Removes all map-key-join-column elements 
    * @return the current instance of MapKeyJoinColumn> 
    */
   public ElementCollection removeAllMapKeyJoinColumn();

 
   // --------------------------------------------------------------------------------------------------------||
   // ClassName: ElementCollection ElementName: orm:foreign-key ElementType : map-key-foreign-key
   // MaxOccurs: -  isGeneric: true   isAttribute: false isEnum: false isDataType: false
   // --------------------------------------------------------------------------------------------------------||

   /**
    * If not already created, a new map-key-foreign-key element with the given value will be created.
    * Otherwise, the existing map-key-foreign-key element will be returned.
    * @return  a new or existing instance of ForeignKey> 
    */
   public ForeignKey> getOrCreateMapKeyForeignKey();

   /**
    * Removes the map-key-foreign-key element 
    * @return the current instance of ElementCollection 
    */
   public ElementCollection removeMapKeyForeignKey();

 
   // --------------------------------------------------------------------------------------------------------||
   // ClassName: ElementCollection ElementName: orm:column ElementType : column
   // MaxOccurs: -  isGeneric: true   isAttribute: false isEnum: false isDataType: false
   // --------------------------------------------------------------------------------------------------------||

   /**
    * If not already created, a new column element with the given value will be created.
    * Otherwise, the existing column element will be returned.
    * @return  a new or existing instance of Column> 
    */
   public Column> getOrCreateColumn();

   /**
    * Removes the column element 
    * @return the current instance of ElementCollection 
    */
   public ElementCollection removeColumn();

 
   // --------------------------------------------------------------------------------------------------------||
   // ClassName: ElementCollection ElementName: orm:temporal-type ElementType : temporal
   // MaxOccurs: -  isGeneric: true   isAttribute: false isEnum: true isDataType: false
   // --------------------------------------------------------------------------------------------------------||
   /**
    * Sets the temporal element
    * @param temporal the value for the element temporal 
    * @return the current instance of ElementCollection 
    */
   public ElementCollection temporal(TemporalType temporal);
   /**
    * Sets the temporal element
    * @param temporal the value for the element temporal 
    * @return the current instance of ElementCollection 
    */
   public ElementCollection temporal(String temporal);

   /**
    * Returns the temporal element
    * @return the value found for the element temporal 
    */
   public TemporalType getTemporal();

   /**
    * Returns the temporal element
    * @return the value found for the element temporal 
    */
   public String  getTemporalAsString();

   /**
    * Removes the temporal attribute 
    * @return the current instance of ElementCollection 
    */
   public ElementCollection removeTemporal();

 
   // --------------------------------------------------------------------------------------------------------||
   // ClassName: ElementCollection ElementName: orm:enum-type ElementType : enumerated
   // MaxOccurs: -  isGeneric: true   isAttribute: false isEnum: true isDataType: false
   // --------------------------------------------------------------------------------------------------------||
   /**
    * Sets the enumerated element
    * @param enumerated the value for the element enumerated 
    * @return the current instance of ElementCollection 
    */
   public ElementCollection enumerated(EnumType enumerated);
   /**
    * Sets the enumerated element
    * @param enumerated the value for the element enumerated 
    * @return the current instance of ElementCollection 
    */
   public ElementCollection enumerated(String enumerated);

   /**
    * Returns the enumerated element
    * @return the value found for the element enumerated 
    */
   public EnumType getEnumerated();

   /**
    * Returns the enumerated element
    * @return the value found for the element enumerated 
    */
   public String  getEnumeratedAsString();

   /**
    * Removes the enumerated attribute 
    * @return the current instance of ElementCollection 
    */
   public ElementCollection removeEnumerated();

 
   // --------------------------------------------------------------------------------------------------------||
   // ClassName: ElementCollection ElementName: javaee:emptyType ElementType : lob
   // MaxOccurs: -  isGeneric: true   isAttribute: false isEnum: false isDataType: true
   // --------------------------------------------------------------------------------------------------------||

   /**
    * Sets the lob element 
    * @return the current instance of ElementCollection 
    */
   public ElementCollection lob();

   /**
    * Removes the lob element 
    * @return the current instance of ElementCollection 
    */
   public Boolean isLob();

   /**
    * Removes the lob element 
    * @return the current instance of ElementCollection 
    */
   public ElementCollection removeLob();

 
   // --------------------------------------------------------------------------------------------------------||
   // ClassName: ElementCollection ElementName: orm:attribute-override ElementType : attribute-override
   // MaxOccurs: -unbounded  isGeneric: true   isAttribute: false isEnum: false isDataType: false
   // --------------------------------------------------------------------------------------------------------||

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

   /**
    * Creates a new attribute-override element 
    * @return the new created instance of AttributeOverride> 
    */
   public AttributeOverride> createAttributeOverride();

   /**
    * Returns all attribute-override elements
    * @return list of attribute-override 
    */
   public List>> getAllAttributeOverride();

   /**
    * Removes all attribute-override elements 
    * @return the current instance of AttributeOverride> 
    */
   public ElementCollection removeAllAttributeOverride();

 
   // --------------------------------------------------------------------------------------------------------||
   // ClassName: ElementCollection ElementName: orm:association-override ElementType : association-override
   // MaxOccurs: -unbounded  isGeneric: true   isAttribute: false isEnum: false isDataType: false
   // --------------------------------------------------------------------------------------------------------||

   /**
    * If not already created, a new association-override element will be created and returned.
    * Otherwise, the first existing association-override element will be returned.
    * @return the instance defined for the element association-override 
    */
   public AssociationOverride> getOrCreateAssociationOverride();

   /**
    * Creates a new association-override element 
    * @return the new created instance of AssociationOverride> 
    */
   public AssociationOverride> createAssociationOverride();

   /**
    * Returns all association-override elements
    * @return list of association-override 
    */
   public List>> getAllAssociationOverride();

   /**
    * Removes all association-override elements 
    * @return the current instance of AssociationOverride> 
    */
   public ElementCollection removeAllAssociationOverride();

 
   // --------------------------------------------------------------------------------------------------------||
   // ClassName: ElementCollection ElementName: orm:convert ElementType : convert
   // MaxOccurs: -unbounded  isGeneric: true   isAttribute: false isEnum: false isDataType: false
   // --------------------------------------------------------------------------------------------------------||

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

   /**
    * Creates a new convert element 
    * @return the new created instance of Convert> 
    */
   public Convert> createConvert();

   /**
    * Returns all convert elements
    * @return list of convert 
    */
   public List>> getAllConvert();

   /**
    * Removes all convert elements 
    * @return the current instance of Convert> 
    */
   public ElementCollection removeAllConvert();

 
   // --------------------------------------------------------------------------------------------------------||
   // ClassName: ElementCollection ElementName: orm:collection-table ElementType : collection-table
   // MaxOccurs: -  isGeneric: true   isAttribute: false isEnum: false isDataType: false
   // --------------------------------------------------------------------------------------------------------||

   /**
    * If not already created, a new collection-table element with the given value will be created.
    * Otherwise, the existing collection-table element will be returned.
    * @return  a new or existing instance of CollectionTable> 
    */
   public CollectionTable> getOrCreateCollectionTable();

   /**
    * Removes the collection-table element 
    * @return the current instance of ElementCollection 
    */
   public ElementCollection removeCollectionTable();

 
   // --------------------------------------------------------------------------------------------------------||
   // ClassName: ElementCollection 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 ElementCollection 
    */
   public ElementCollection 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 ElementCollection 
    */
   public ElementCollection removeName();

 
   // --------------------------------------------------------------------------------------------------------||
   // ClassName: ElementCollection ElementName: xsd:string ElementType : target-class
   // MaxOccurs: -  isGeneric: true   isAttribute: true isEnum: false isDataType: true
   // --------------------------------------------------------------------------------------------------------||

   /**
    * Sets the target-class attribute
    * @param targetClass the value for the attribute target-class 
    * @return the current instance of ElementCollection 
    */
   public ElementCollection targetClass(String targetClass);

   /**
    * Returns the target-class attribute
    * @return the value defined for the attribute target-class 
    */
   public String getTargetClass();

   /**
    * Removes the target-class attribute 
    * @return the current instance of ElementCollection 
    */
   public ElementCollection removeTargetClass();

 
   // --------------------------------------------------------------------------------------------------------||
   // ClassName: ElementCollection ElementName: orm:fetch-type ElementType : fetch
   // MaxOccurs: -  isGeneric: true   isAttribute: true isEnum: true isDataType: false
   // --------------------------------------------------------------------------------------------------------||

   /**
    * Sets the fetch attribute
    * @param fetch the value for the attribute fetch 
    * @return the current instance of ElementCollection 
    */
   public ElementCollection fetch(FetchType fetch);

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

   /**
    * Returns the fetch attribute
    * @return the value defined for the attribute fetch 
    */
public FetchType getFetch();

   /**
    * Returns the fetch attribute
    * @return the value found for the element fetch 
    */
   public String  getFetchAsString();

   /**
    * Removes the fetch attribute 
    * @return the current instance of ElementCollection 
    */
   public ElementCollection removeFetch();

 
   // --------------------------------------------------------------------------------------------------------||
   // ClassName: ElementCollection ElementName: orm:access-type ElementType : access
   // MaxOccurs: -  isGeneric: true   isAttribute: true isEnum: true isDataType: false
   // --------------------------------------------------------------------------------------------------------||

   /**
    * Sets the access attribute
    * @param access the value for the attribute access 
    * @return the current instance of ElementCollection 
    */
   public ElementCollection access(AccessType access);

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

   /**
    * Returns the access attribute
    * @return the value defined for the attribute access 
    */
public AccessType getAccess();

   /**
    * Returns the access attribute
    * @return the value found for the element access 
    */
   public String  getAccessAsString();

   /**
    * Removes the access attribute 
    * @return the current instance of ElementCollection 
    */
   public ElementCollection removeAccess();
}




© 2015 - 2024 Weber Informatics LLC | Privacy Policy