org.jboss.shrinkwrap.descriptor.api.orm21.Entity Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of shrinkwrap-descriptors-api-javaee Show documentation
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.Table;
import org.jboss.shrinkwrap.descriptor.api.orm21.SecondaryTable;
import org.jboss.shrinkwrap.descriptor.api.orm21.PrimaryKeyJoinColumn;
import org.jboss.shrinkwrap.descriptor.api.orm21.ForeignKey;
import org.jboss.shrinkwrap.descriptor.api.orm21.IdClass;
import org.jboss.shrinkwrap.descriptor.api.orm21.Inheritance;
import org.jboss.shrinkwrap.descriptor.api.orm21.DiscriminatorColumn;
import org.jboss.shrinkwrap.descriptor.api.orm21.SequenceGenerator;
import org.jboss.shrinkwrap.descriptor.api.orm21.TableGenerator;
import org.jboss.shrinkwrap.descriptor.api.orm21.NamedQuery;
import org.jboss.shrinkwrap.descriptor.api.orm21.NamedNativeQuery;
import org.jboss.shrinkwrap.descriptor.api.orm21.NamedStoredProcedureQuery;
import org.jboss.shrinkwrap.descriptor.api.orm21.SqlResultSetMapping;
import org.jboss.shrinkwrap.descriptor.api.orm21.EntityListeners;
import org.jboss.shrinkwrap.descriptor.api.orm21.PrePersist;
import org.jboss.shrinkwrap.descriptor.api.orm21.PostPersist;
import org.jboss.shrinkwrap.descriptor.api.orm21.PreRemove;
import org.jboss.shrinkwrap.descriptor.api.orm21.PostRemove;
import org.jboss.shrinkwrap.descriptor.api.orm21.PreUpdate;
import org.jboss.shrinkwrap.descriptor.api.orm21.PostUpdate;
import org.jboss.shrinkwrap.descriptor.api.orm21.PostLoad;
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.NamedEntityGraph;
import org.jboss.shrinkwrap.descriptor.api.orm21.Attributes;
import org.jboss.shrinkwrap.descriptor.api.orm21.AccessType;
import org.jboss.shrinkwrap.descriptor.api.orm.*;
import org.jboss.shrinkwrap.descriptor.api.orm.OrmEntityCommType;
import org.jboss.shrinkwrap.descriptor.api.orm21.Table;
import org.jboss.shrinkwrap.descriptor.api.orm21.SecondaryTable;
import org.jboss.shrinkwrap.descriptor.api.orm21.PrimaryKeyJoinColumn;
import org.jboss.shrinkwrap.descriptor.api.orm21.IdClass;
import org.jboss.shrinkwrap.descriptor.api.orm21.Inheritance;
import org.jboss.shrinkwrap.descriptor.api.orm21.DiscriminatorColumn;
import org.jboss.shrinkwrap.descriptor.api.orm21.SequenceGenerator;
import org.jboss.shrinkwrap.descriptor.api.orm21.TableGenerator;
import org.jboss.shrinkwrap.descriptor.api.orm21.NamedQuery;
import org.jboss.shrinkwrap.descriptor.api.orm21.NamedNativeQuery;
import org.jboss.shrinkwrap.descriptor.api.orm21.SqlResultSetMapping;
import org.jboss.shrinkwrap.descriptor.api.orm21.EntityListeners;
import org.jboss.shrinkwrap.descriptor.api.orm21.PrePersist;
import org.jboss.shrinkwrap.descriptor.api.orm21.PostPersist;
import org.jboss.shrinkwrap.descriptor.api.orm21.PreRemove;
import org.jboss.shrinkwrap.descriptor.api.orm21.PostRemove;
import org.jboss.shrinkwrap.descriptor.api.orm21.PreUpdate;
import org.jboss.shrinkwrap.descriptor.api.orm21.PostUpdate;
import org.jboss.shrinkwrap.descriptor.api.orm21.PostLoad;
import org.jboss.shrinkwrap.descriptor.api.orm21.AttributeOverride;
import org.jboss.shrinkwrap.descriptor.api.orm21.AssociationOverride;
import org.jboss.shrinkwrap.descriptor.api.orm21.Attributes;/**
* This interface defines the contract for the entity xsd type
* @author Ralf Battenfeld
* @author Andrew Lee Rubinger
*/
public interface Entity extends Child,
OrmEntityCommType,
Table>,
SecondaryTable>,
PrimaryKeyJoinColumn>,
IdClass>,
Inheritance>,
DiscriminatorColumn>,
SequenceGenerator>,
TableGenerator>,
NamedQuery>,
NamedNativeQuery>,
SqlResultSetMapping>,
EntityListeners>,
PrePersist>,
PostPersist>,
PreRemove>,
PostRemove>,
PreUpdate>,
PostUpdate>,
PostLoad>,
AttributeOverride>,
AssociationOverride>,
Attributes>> {
// --------------------------------------------------------------------------------------------------------||
// ClassName: Entity ElementName: xsd:string ElementType : description
// MaxOccurs: - isGeneric: true isAttribute: false isEnum: false isDataType: true
// --------------------------------------------------------------------------------------------------------||
/**
* Sets the description element
* @param description the value for the element description
* @return the current instance of Entity
*/
public Entity description(String description);
/**
* Returns the description element
* @return the node defined for the element description
*/
public String getDescription();
/**
* Removes the description element
* @return the current instance of Entity
*/
public Entity removeDescription();
// --------------------------------------------------------------------------------------------------------||
// ClassName: Entity ElementName: orm:table ElementType : table
// MaxOccurs: - isGeneric: true isAttribute: false isEnum: false isDataType: false
// --------------------------------------------------------------------------------------------------------||
/**
* If not already created, a new table element with the given value will be created.
* Otherwise, the existing table element will be returned.
* @return a new or existing instance of Table>
*/
public Table> getOrCreateTable();
/**
* Removes the table element
* @return the current instance of Entity
*/
public Entity removeTable();
// --------------------------------------------------------------------------------------------------------||
// ClassName: Entity ElementName: orm:secondary-table ElementType : secondary-table
// MaxOccurs: -unbounded isGeneric: true isAttribute: false isEnum: false isDataType: false
// --------------------------------------------------------------------------------------------------------||
/**
* If not already created, a new secondary-table element will be created and returned.
* Otherwise, the first existing secondary-table element will be returned.
* @return the instance defined for the element secondary-table
*/
public SecondaryTable> getOrCreateSecondaryTable();
/**
* Creates a new secondary-table element
* @return the new created instance of SecondaryTable>
*/
public SecondaryTable> createSecondaryTable();
/**
* Returns all secondary-table elements
* @return list of secondary-table
*/
public List>> getAllSecondaryTable();
/**
* Removes all secondary-table elements
* @return the current instance of SecondaryTable>
*/
public Entity removeAllSecondaryTable();
// --------------------------------------------------------------------------------------------------------||
// ClassName: Entity ElementName: orm:primary-key-join-column ElementType : primary-key-join-column
// MaxOccurs: -unbounded isGeneric: true isAttribute: false isEnum: false isDataType: false
// --------------------------------------------------------------------------------------------------------||
/**
* If not already created, a new primary-key-join-column element will be created and returned.
* Otherwise, the first existing primary-key-join-column element will be returned.
* @return the instance defined for the element primary-key-join-column
*/
public PrimaryKeyJoinColumn> getOrCreatePrimaryKeyJoinColumn();
/**
* Creates a new primary-key-join-column element
* @return the new created instance of PrimaryKeyJoinColumn>
*/
public PrimaryKeyJoinColumn> createPrimaryKeyJoinColumn();
/**
* Returns all primary-key-join-column elements
* @return list of primary-key-join-column
*/
public List>> getAllPrimaryKeyJoinColumn();
/**
* Removes all primary-key-join-column elements
* @return the current instance of PrimaryKeyJoinColumn>
*/
public Entity removeAllPrimaryKeyJoinColumn();
// --------------------------------------------------------------------------------------------------------||
// ClassName: Entity ElementName: orm:foreign-key ElementType : primary-key-foreign-key
// MaxOccurs: - isGeneric: true isAttribute: false isEnum: false isDataType: false
// --------------------------------------------------------------------------------------------------------||
/**
* If not already created, a new primary-key-foreign-key element with the given value will be created.
* Otherwise, the existing primary-key-foreign-key element will be returned.
* @return a new or existing instance of ForeignKey>
*/
public ForeignKey> getOrCreatePrimaryKeyForeignKey();
/**
* Removes the primary-key-foreign-key element
* @return the current instance of Entity
*/
public Entity removePrimaryKeyForeignKey();
// --------------------------------------------------------------------------------------------------------||
// ClassName: Entity ElementName: orm:id-class ElementType : id-class
// MaxOccurs: - isGeneric: true isAttribute: false isEnum: false isDataType: false
// --------------------------------------------------------------------------------------------------------||
/**
* If not already created, a new id-class element with the given value will be created.
* Otherwise, the existing id-class element will be returned.
* @return a new or existing instance of IdClass>
*/
public IdClass> getOrCreateIdClass();
/**
* Removes the id-class element
* @return the current instance of Entity
*/
public Entity removeIdClass();
// --------------------------------------------------------------------------------------------------------||
// ClassName: Entity ElementName: orm:inheritance ElementType : inheritance
// MaxOccurs: - isGeneric: true isAttribute: false isEnum: false isDataType: false
// --------------------------------------------------------------------------------------------------------||
/**
* If not already created, a new inheritance element with the given value will be created.
* Otherwise, the existing inheritance element will be returned.
* @return a new or existing instance of Inheritance>
*/
public Inheritance> getOrCreateInheritance();
/**
* Removes the inheritance element
* @return the current instance of Entity
*/
public Entity removeInheritance();
// --------------------------------------------------------------------------------------------------------||
// ClassName: Entity ElementName: xsd:string ElementType : discriminator-value
// MaxOccurs: - isGeneric: true isAttribute: false isEnum: false isDataType: true
// --------------------------------------------------------------------------------------------------------||
/**
* Sets the discriminator-value element
* @param discriminatorValue the value for the element discriminator-value
* @return the current instance of Entity
*/
public Entity discriminatorValue(String discriminatorValue);
/**
* Returns the discriminator-value element
* @return the node defined for the element discriminator-value
*/
public String getDiscriminatorValue();
/**
* Removes the discriminator-value element
* @return the current instance of Entity
*/
public Entity removeDiscriminatorValue();
// --------------------------------------------------------------------------------------------------------||
// ClassName: Entity ElementName: orm:discriminator-column ElementType : discriminator-column
// MaxOccurs: - isGeneric: true isAttribute: false isEnum: false isDataType: false
// --------------------------------------------------------------------------------------------------------||
/**
* If not already created, a new discriminator-column element with the given value will be created.
* Otherwise, the existing discriminator-column element will be returned.
* @return a new or existing instance of DiscriminatorColumn>
*/
public DiscriminatorColumn> getOrCreateDiscriminatorColumn();
/**
* Removes the discriminator-column element
* @return the current instance of Entity
*/
public Entity removeDiscriminatorColumn();
// --------------------------------------------------------------------------------------------------------||
// ClassName: Entity ElementName: orm:sequence-generator ElementType : sequence-generator
// MaxOccurs: - isGeneric: true isAttribute: false isEnum: false isDataType: false
// --------------------------------------------------------------------------------------------------------||
/**
* If not already created, a new sequence-generator element with the given value will be created.
* Otherwise, the existing sequence-generator element will be returned.
* @return a new or existing instance of SequenceGenerator>
*/
public SequenceGenerator> getOrCreateSequenceGenerator();
/**
* Removes the sequence-generator element
* @return the current instance of Entity
*/
public Entity removeSequenceGenerator();
// --------------------------------------------------------------------------------------------------------||
// ClassName: Entity ElementName: orm:table-generator ElementType : table-generator
// MaxOccurs: - isGeneric: true isAttribute: false isEnum: false isDataType: false
// --------------------------------------------------------------------------------------------------------||
/**
* If not already created, a new table-generator element with the given value will be created.
* Otherwise, the existing table-generator element will be returned.
* @return a new or existing instance of TableGenerator>
*/
public TableGenerator> getOrCreateTableGenerator();
/**
* Removes the table-generator element
* @return the current instance of Entity
*/
public Entity removeTableGenerator();
// --------------------------------------------------------------------------------------------------------||
// ClassName: Entity ElementName: orm:named-query ElementType : named-query
// MaxOccurs: -unbounded isGeneric: true isAttribute: false isEnum: false isDataType: false
// --------------------------------------------------------------------------------------------------------||
/**
* If not already created, a new named-query element will be created and returned.
* Otherwise, the first existing named-query element will be returned.
* @return the instance defined for the element named-query
*/
public NamedQuery> getOrCreateNamedQuery();
/**
* Creates a new named-query element
* @return the new created instance of NamedQuery>
*/
public NamedQuery> createNamedQuery();
/**
* Returns all named-query elements
* @return list of named-query
*/
public List>> getAllNamedQuery();
/**
* Removes all named-query elements
* @return the current instance of NamedQuery>
*/
public Entity removeAllNamedQuery();
// --------------------------------------------------------------------------------------------------------||
// ClassName: Entity ElementName: orm:named-native-query ElementType : named-native-query
// MaxOccurs: -unbounded isGeneric: true isAttribute: false isEnum: false isDataType: false
// --------------------------------------------------------------------------------------------------------||
/**
* If not already created, a new named-native-query element will be created and returned.
* Otherwise, the first existing named-native-query element will be returned.
* @return the instance defined for the element named-native-query
*/
public NamedNativeQuery> getOrCreateNamedNativeQuery();
/**
* Creates a new named-native-query element
* @return the new created instance of NamedNativeQuery>
*/
public NamedNativeQuery> createNamedNativeQuery();
/**
* Returns all named-native-query elements
* @return list of named-native-query
*/
public List>> getAllNamedNativeQuery();
/**
* Removes all named-native-query elements
* @return the current instance of NamedNativeQuery>
*/
public Entity removeAllNamedNativeQuery();
// --------------------------------------------------------------------------------------------------------||
// ClassName: Entity ElementName: orm:named-stored-procedure-query ElementType : named-stored-procedure-query
// MaxOccurs: -unbounded isGeneric: true isAttribute: false isEnum: false isDataType: false
// --------------------------------------------------------------------------------------------------------||
/**
* If not already created, a new named-stored-procedure-query element will be created and returned.
* Otherwise, the first existing named-stored-procedure-query element will be returned.
* @return the instance defined for the element named-stored-procedure-query
*/
public NamedStoredProcedureQuery> getOrCreateNamedStoredProcedureQuery();
/**
* Creates a new named-stored-procedure-query element
* @return the new created instance of NamedStoredProcedureQuery>
*/
public NamedStoredProcedureQuery> createNamedStoredProcedureQuery();
/**
* Returns all named-stored-procedure-query elements
* @return list of named-stored-procedure-query
*/
public List>> getAllNamedStoredProcedureQuery();
/**
* Removes all named-stored-procedure-query elements
* @return the current instance of NamedStoredProcedureQuery>
*/
public Entity removeAllNamedStoredProcedureQuery();
// --------------------------------------------------------------------------------------------------------||
// ClassName: Entity ElementName: orm:sql-result-set-mapping ElementType : sql-result-set-mapping
// MaxOccurs: -unbounded isGeneric: true isAttribute: false isEnum: false isDataType: false
// --------------------------------------------------------------------------------------------------------||
/**
* If not already created, a new sql-result-set-mapping element will be created and returned.
* Otherwise, the first existing sql-result-set-mapping element will be returned.
* @return the instance defined for the element sql-result-set-mapping
*/
public SqlResultSetMapping> getOrCreateSqlResultSetMapping();
/**
* Creates a new sql-result-set-mapping element
* @return the new created instance of SqlResultSetMapping>
*/
public SqlResultSetMapping> createSqlResultSetMapping();
/**
* Returns all sql-result-set-mapping elements
* @return list of sql-result-set-mapping
*/
public List>> getAllSqlResultSetMapping();
/**
* Removes all sql-result-set-mapping elements
* @return the current instance of SqlResultSetMapping>
*/
public Entity removeAllSqlResultSetMapping();
// --------------------------------------------------------------------------------------------------------||
// ClassName: Entity ElementName: javaee:emptyType ElementType : exclude-default-listeners
// MaxOccurs: - isGeneric: true isAttribute: false isEnum: false isDataType: true
// --------------------------------------------------------------------------------------------------------||
/**
* Sets the exclude-default-listeners element
* @return the current instance of Entity
*/
public Entity excludeDefaultListeners();
/**
* Removes the exclude-default-listeners element
* @return the current instance of Entity
*/
public Boolean isExcludeDefaultListeners();
/**
* Removes the exclude-default-listeners element
* @return the current instance of Entity
*/
public Entity removeExcludeDefaultListeners();
// --------------------------------------------------------------------------------------------------------||
// ClassName: Entity ElementName: javaee:emptyType ElementType : exclude-superclass-listeners
// MaxOccurs: - isGeneric: true isAttribute: false isEnum: false isDataType: true
// --------------------------------------------------------------------------------------------------------||
/**
* Sets the exclude-superclass-listeners element
* @return the current instance of Entity
*/
public Entity excludeSuperclassListeners();
/**
* Removes the exclude-superclass-listeners element
* @return the current instance of Entity
*/
public Boolean isExcludeSuperclassListeners();
/**
* Removes the exclude-superclass-listeners element
* @return the current instance of Entity
*/
public Entity removeExcludeSuperclassListeners();
// --------------------------------------------------------------------------------------------------------||
// ClassName: Entity ElementName: orm:entity-listeners ElementType : entity-listeners
// MaxOccurs: - isGeneric: true isAttribute: false isEnum: false isDataType: false
// --------------------------------------------------------------------------------------------------------||
/**
* If not already created, a new entity-listeners element with the given value will be created.
* Otherwise, the existing entity-listeners element will be returned.
* @return a new or existing instance of EntityListeners>
*/
public EntityListeners> getOrCreateEntityListeners();
/**
* Removes the entity-listeners element
* @return the current instance of Entity
*/
public Entity removeEntityListeners();
// --------------------------------------------------------------------------------------------------------||
// ClassName: Entity ElementName: orm:pre-persist ElementType : pre-persist
// MaxOccurs: - isGeneric: true isAttribute: false isEnum: false isDataType: false
// --------------------------------------------------------------------------------------------------------||
/**
* If not already created, a new pre-persist element with the given value will be created.
* Otherwise, the existing pre-persist element will be returned.
* @return a new or existing instance of PrePersist>
*/
public PrePersist> getOrCreatePrePersist();
/**
* Removes the pre-persist element
* @return the current instance of Entity
*/
public Entity removePrePersist();
// --------------------------------------------------------------------------------------------------------||
// ClassName: Entity ElementName: orm:post-persist ElementType : post-persist
// MaxOccurs: - isGeneric: true isAttribute: false isEnum: false isDataType: false
// --------------------------------------------------------------------------------------------------------||
/**
* If not already created, a new post-persist element with the given value will be created.
* Otherwise, the existing post-persist element will be returned.
* @return a new or existing instance of PostPersist>
*/
public PostPersist> getOrCreatePostPersist();
/**
* Removes the post-persist element
* @return the current instance of Entity
*/
public Entity removePostPersist();
// --------------------------------------------------------------------------------------------------------||
// ClassName: Entity ElementName: orm:pre-remove ElementType : pre-remove
// MaxOccurs: - isGeneric: true isAttribute: false isEnum: false isDataType: false
// --------------------------------------------------------------------------------------------------------||
/**
* If not already created, a new pre-remove element with the given value will be created.
* Otherwise, the existing pre-remove element will be returned.
* @return a new or existing instance of PreRemove>
*/
public PreRemove> getOrCreatePreRemove();
/**
* Removes the pre-remove element
* @return the current instance of Entity
*/
public Entity removePreRemove();
// --------------------------------------------------------------------------------------------------------||
// ClassName: Entity ElementName: orm:post-remove ElementType : post-remove
// MaxOccurs: - isGeneric: true isAttribute: false isEnum: false isDataType: false
// --------------------------------------------------------------------------------------------------------||
/**
* If not already created, a new post-remove element with the given value will be created.
* Otherwise, the existing post-remove element will be returned.
* @return a new or existing instance of PostRemove>
*/
public PostRemove> getOrCreatePostRemove();
/**
* Removes the post-remove element
* @return the current instance of Entity
*/
public Entity removePostRemove();
// --------------------------------------------------------------------------------------------------------||
// ClassName: Entity ElementName: orm:pre-update ElementType : pre-update
// MaxOccurs: - isGeneric: true isAttribute: false isEnum: false isDataType: false
// --------------------------------------------------------------------------------------------------------||
/**
* If not already created, a new pre-update element with the given value will be created.
* Otherwise, the existing pre-update element will be returned.
* @return a new or existing instance of PreUpdate>
*/
public PreUpdate> getOrCreatePreUpdate();
/**
* Removes the pre-update element
* @return the current instance of Entity
*/
public Entity removePreUpdate();
// --------------------------------------------------------------------------------------------------------||
// ClassName: Entity ElementName: orm:post-update ElementType : post-update
// MaxOccurs: - isGeneric: true isAttribute: false isEnum: false isDataType: false
// --------------------------------------------------------------------------------------------------------||
/**
* If not already created, a new post-update element with the given value will be created.
* Otherwise, the existing post-update element will be returned.
* @return a new or existing instance of PostUpdate>
*/
public PostUpdate> getOrCreatePostUpdate();
/**
* Removes the post-update element
* @return the current instance of Entity
*/
public Entity removePostUpdate();
// --------------------------------------------------------------------------------------------------------||
// ClassName: Entity ElementName: orm:post-load ElementType : post-load
// MaxOccurs: - isGeneric: true isAttribute: false isEnum: false isDataType: false
// --------------------------------------------------------------------------------------------------------||
/**
* If not already created, a new post-load element with the given value will be created.
* Otherwise, the existing post-load element will be returned.
* @return a new or existing instance of PostLoad>
*/
public PostLoad> getOrCreatePostLoad();
/**
* Removes the post-load element
* @return the current instance of Entity
*/
public Entity removePostLoad();
// --------------------------------------------------------------------------------------------------------||
// ClassName: Entity 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 Entity removeAllAttributeOverride();
// --------------------------------------------------------------------------------------------------------||
// ClassName: Entity 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 Entity removeAllAssociationOverride();
// --------------------------------------------------------------------------------------------------------||
// ClassName: Entity 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 Entity removeAllConvert();
// --------------------------------------------------------------------------------------------------------||
// ClassName: Entity ElementName: orm:named-entity-graph ElementType : named-entity-graph
// MaxOccurs: -unbounded isGeneric: true isAttribute: false isEnum: false isDataType: false
// --------------------------------------------------------------------------------------------------------||
/**
* If not already created, a new named-entity-graph element will be created and returned.
* Otherwise, the first existing named-entity-graph element will be returned.
* @return the instance defined for the element named-entity-graph
*/
public NamedEntityGraph> getOrCreateNamedEntityGraph();
/**
* Creates a new named-entity-graph element
* @return the new created instance of NamedEntityGraph>
*/
public NamedEntityGraph> createNamedEntityGraph();
/**
* Returns all named-entity-graph elements
* @return list of named-entity-graph
*/
public List>> getAllNamedEntityGraph();
/**
* Removes all named-entity-graph elements
* @return the current instance of NamedEntityGraph>
*/
public Entity removeAllNamedEntityGraph();
// --------------------------------------------------------------------------------------------------------||
// ClassName: Entity ElementName: orm:attributes ElementType : attributes
// MaxOccurs: - isGeneric: true isAttribute: false isEnum: false isDataType: false
// --------------------------------------------------------------------------------------------------------||
/**
* If not already created, a new attributes element with the given value will be created.
* Otherwise, the existing attributes element will be returned.
* @return a new or existing instance of Attributes>
*/
public Attributes> getOrCreateAttributes();
/**
* Removes the attributes element
* @return the current instance of Entity
*/
public Entity removeAttributes();
// --------------------------------------------------------------------------------------------------------||
// ClassName: Entity 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 Entity
*/
public Entity 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 Entity
*/
public Entity removeName();
// --------------------------------------------------------------------------------------------------------||
// ClassName: Entity ElementName: xsd:string ElementType : class
// MaxOccurs: - isGeneric: true isAttribute: true isEnum: false isDataType: true
// --------------------------------------------------------------------------------------------------------||
/**
* Sets the class attribute
* @param clazz the value for the attribute class
* @return the current instance of Entity
*/
public Entity clazz(String clazz);
/**
* Returns the class attribute
* @return the value defined for the attribute class
*/
public String getClazz();
/**
* Removes the class attribute
* @return the current instance of Entity
*/
public Entity removeClazzAttr();
// --------------------------------------------------------------------------------------------------------||
// ClassName: Entity 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 Entity
*/
public Entity access(AccessType access);
/**
* Sets the access attribute
* @param access the value for the attribute access
* @return the current instance of Entity
*/
public Entity 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 Entity
*/
public Entity removeAccess();
// --------------------------------------------------------------------------------------------------------||
// ClassName: Entity ElementName: xsd:boolean ElementType : cacheable
// MaxOccurs: - isGeneric: true isAttribute: true isEnum: false isDataType: true
// --------------------------------------------------------------------------------------------------------||
/**
* Sets the cacheable attribute
* @param cacheable the value for the attribute cacheable
* @return the current instance of Entity
*/
public Entity cacheable(Boolean cacheable);
/**
* Returns the cacheable attribute
* @return the value defined for the attribute cacheable
*/
public Boolean isCacheable();
/**
* Removes the cacheable attribute
* @return the current instance of Entity
*/
public Entity removeCacheable();
// --------------------------------------------------------------------------------------------------------||
// ClassName: Entity ElementName: xsd:boolean ElementType : metadata-complete
// MaxOccurs: - isGeneric: true isAttribute: true isEnum: false isDataType: true
// --------------------------------------------------------------------------------------------------------||
/**
* Sets the metadata-complete attribute
* @param metadataComplete the value for the attribute metadata-complete
* @return the current instance of Entity
*/
public Entity metadataComplete(Boolean metadataComplete);
/**
* Returns the metadata-complete attribute
* @return the value defined for the attribute metadata-complete
*/
public Boolean isMetadataComplete();
/**
* Removes the metadata-complete attribute
* @return the current instance of Entity
*/
public Entity removeMetadataComplete();
}