ShrinkWrap Descriptors Generated Java EE API 2.0.0-alpha-3

org.jboss.shrinkwrap.descriptor.api.orm20
Interface Entity<T>

All Superinterfaces:
Child<T>

public interface Entity<T>
extends Child<T>

This interface defines the contract for the entity xsd type

Since:
Generation date :2012-05-09T23:45:05.33-07:00
Author:
Ralf Battenfeld, Andrew Lee Rubinger

Method Summary
 Entity<T> access(AccessType access)
          Sets the access attribute
 Entity<T> access(String access)
          Sets the access attribute
 Entity<T> cacheable(Boolean cacheable)
          Sets the cacheable attribute
 Entity<T> clazz(String clazz)
          Sets the class attribute
 AssociationOverride<Entity<T>> createAssociationOverride()
          Creates a new association-override element
 AttributeOverride<Entity<T>> createAttributeOverride()
          Creates a new attribute-override element
 NamedNativeQuery<Entity<T>> createNamedNativeQuery()
          Creates a new named-native-query element
 NamedQuery<Entity<T>> createNamedQuery()
          Creates a new named-query element
 PrimaryKeyJoinColumn<Entity<T>> createPrimaryKeyJoinColumn()
          Creates a new primary-key-join-column element
 SecondaryTable<Entity<T>> createSecondaryTable()
          Creates a new secondary-table element
 SqlResultSetMapping<Entity<T>> createSqlResultSetMapping()
          Creates a new sql-result-set-mapping element
 Entity<T> description(String description)
          Sets the description element
 Entity<T> discriminatorValue(String discriminatorValue)
          Sets the discriminator-value element
 Entity<T> excludeDefaultListeners()
          Sets the exclude-default-listeners element
 Entity<T> excludeSuperclassListeners()
          Sets the exclude-superclass-listeners element
 AccessType getAccess()
          Returns the access attribute
 String getAccessAsString()
          Returns the access attribute
 List<AssociationOverride<Entity<T>>> getAllAssociationOverride()
          Returns all association-override elements
 List<AttributeOverride<Entity<T>>> getAllAttributeOverride()
          Returns all attribute-override elements
 List<NamedNativeQuery<Entity<T>>> getAllNamedNativeQuery()
          Returns all named-native-query elements
 List<NamedQuery<Entity<T>>> getAllNamedQuery()
          Returns all named-query elements
 List<PrimaryKeyJoinColumn<Entity<T>>> getAllPrimaryKeyJoinColumn()
          Returns all primary-key-join-column elements
 List<SecondaryTable<Entity<T>>> getAllSecondaryTable()
          Returns all secondary-table elements
 List<SqlResultSetMapping<Entity<T>>> getAllSqlResultSetMapping()
          Returns all sql-result-set-mapping elements
 String getClazz()
          Returns the class attribute
 String getDescription()
          Returns the description element
 String getDiscriminatorValue()
          Returns the discriminator-value element
 String getName()
          Returns the name attribute
 AssociationOverride<Entity<T>> getOrCreateAssociationOverride()
          If not already created, a new association-override element will be created and returned.
 AttributeOverride<Entity<T>> getOrCreateAttributeOverride()
          If not already created, a new attribute-override element will be created and returned.
 Attributes<Entity<T>> getOrCreateAttributes()
          If not already created, a new attributes element with the given value will be created.
 DiscriminatorColumn<Entity<T>> getOrCreateDiscriminatorColumn()
          If not already created, a new discriminator-column element with the given value will be created.
 EntityListeners<Entity<T>> getOrCreateEntityListeners()
          If not already created, a new entity-listeners element with the given value will be created.
 IdClass<Entity<T>> getOrCreateIdClass()
          If not already created, a new id-class element with the given value will be created.
 Inheritance<Entity<T>> getOrCreateInheritance()
          If not already created, a new inheritance element with the given value will be created.
 NamedNativeQuery<Entity<T>> getOrCreateNamedNativeQuery()
          If not already created, a new named-native-query element will be created and returned.
 NamedQuery<Entity<T>> getOrCreateNamedQuery()
          If not already created, a new named-query element will be created and returned.
 PostLoad<Entity<T>> getOrCreatePostLoad()
          If not already created, a new post-load element with the given value will be created.
 PostPersist<Entity<T>> getOrCreatePostPersist()
          If not already created, a new post-persist element with the given value will be created.
 PostRemove<Entity<T>> getOrCreatePostRemove()
          If not already created, a new post-remove element with the given value will be created.
 PostUpdate<Entity<T>> getOrCreatePostUpdate()
          If not already created, a new post-update element with the given value will be created.
 PrePersist<Entity<T>> getOrCreatePrePersist()
          If not already created, a new pre-persist element with the given value will be created.
 PreRemove<Entity<T>> getOrCreatePreRemove()
          If not already created, a new pre-remove element with the given value will be created.
 PreUpdate<Entity<T>> getOrCreatePreUpdate()
          If not already created, a new pre-update element with the given value will be created.
 PrimaryKeyJoinColumn<Entity<T>> getOrCreatePrimaryKeyJoinColumn()
          If not already created, a new primary-key-join-column element will be created and returned.
 SecondaryTable<Entity<T>> getOrCreateSecondaryTable()
          If not already created, a new secondary-table element will be created and returned.
 SequenceGenerator<Entity<T>> getOrCreateSequenceGenerator()
          If not already created, a new sequence-generator element with the given value will be created.
 SqlResultSetMapping<Entity<T>> getOrCreateSqlResultSetMapping()
          If not already created, a new sql-result-set-mapping element will be created and returned.
 Table<Entity<T>> getOrCreateTable()
          If not already created, a new table element with the given value will be created.
 TableGenerator<Entity<T>> getOrCreateTableGenerator()
          If not already created, a new table-generator element with the given value will be created.
 Boolean isCacheable()
          Returns the cacheable attribute
 Boolean isExcludeDefaultListeners()
          Removes the exclude-default-listeners element
 Boolean isExcludeSuperclassListeners()
          Removes the exclude-superclass-listeners element
 Boolean isMetadataComplete()
          Returns the metadata-complete attribute
 Entity<T> metadataComplete(Boolean metadataComplete)
          Sets the metadata-complete attribute
 Entity<T> name(String name)
          Sets the name attribute
 Entity<T> removeAccess()
          Removes the access attribute
 Entity<T> removeAllAssociationOverride()
          Removes all association-override elements
 Entity<T> removeAllAttributeOverride()
          Removes all attribute-override elements
 Entity<T> removeAllNamedNativeQuery()
          Removes all named-native-query elements
 Entity<T> removeAllNamedQuery()
          Removes all named-query elements
 Entity<T> removeAllPrimaryKeyJoinColumn()
          Removes all primary-key-join-column elements
 Entity<T> removeAllSecondaryTable()
          Removes all secondary-table elements
 Entity<T> removeAllSqlResultSetMapping()
          Removes all sql-result-set-mapping elements
 Entity<T> removeAttributes()
          Removes the attributes element
 Entity<T> removeCacheable()
          Removes the cacheable attribute
 Entity<T> removeClazz()
          Removes the class attribute
 Entity<T> removeDescription()
          Removes the description element
 Entity<T> removeDiscriminatorColumn()
          Removes the discriminator-column element
 Entity<T> removeDiscriminatorValue()
          Removes the discriminator-value element
 Entity<T> removeEntityListeners()
          Removes the entity-listeners element
 Entity<T> removeExcludeDefaultListeners()
          Removes the exclude-default-listeners element
 Entity<T> removeExcludeSuperclassListeners()
          Removes the exclude-superclass-listeners element
 Entity<T> removeIdClass()
          Removes the id-class element
 Entity<T> removeInheritance()
          Removes the inheritance element
 Entity<T> removeMetadataComplete()
          Removes the metadata-complete attribute
 Entity<T> removeName()
          Removes the name attribute
 Entity<T> removePostLoad()
          Removes the post-load element
 Entity<T> removePostPersist()
          Removes the post-persist element
 Entity<T> removePostRemove()
          Removes the post-remove element
 Entity<T> removePostUpdate()
          Removes the post-update element
 Entity<T> removePrePersist()
          Removes the pre-persist element
 Entity<T> removePreRemove()
          Removes the pre-remove element
 Entity<T> removePreUpdate()
          Removes the pre-update element
 Entity<T> removeSequenceGenerator()
          Removes the sequence-generator element
 Entity<T> removeTable()
          Removes the table element
 Entity<T> removeTableGenerator()
          Removes the table-generator element
 
Methods inherited from interface org.jboss.shrinkwrap.descriptor.api.Child
up
 

Method Detail

description

Entity<T> description(String description)
Sets the description element

Parameters:
description - the value for the element description
Returns:
the current instance of Entity

getDescription

String getDescription()
Returns the description element

Returns:
the node defined for the element description

removeDescription

Entity<T> removeDescription()
Removes the description element

Returns:
the current instance of Entity

getOrCreateTable

Table<Entity<T>> getOrCreateTable()
If not already created, a new table element with the given value will be created. Otherwise, the existing table element will be returned.

Returns:
a new or existing instance of Table>

removeTable

Entity<T> removeTable()
Removes the table element

Returns:
the current instance of Entity

getOrCreateSecondaryTable

SecondaryTable<Entity<T>> getOrCreateSecondaryTable()
If not already created, a new secondary-table element will be created and returned. Otherwise, the first existing secondary-table element will be returned.

Returns:
the instance defined for the element secondary-table

createSecondaryTable

SecondaryTable<Entity<T>> createSecondaryTable()
Creates a new secondary-table element

Returns:
the new created instance of SecondaryTable>

getAllSecondaryTable

List<SecondaryTable<Entity<T>>> getAllSecondaryTable()
Returns all secondary-table elements

Returns:
list of secondary-table

removeAllSecondaryTable

Entity<T> removeAllSecondaryTable()
Removes all secondary-table elements

Returns:
the current instance of SecondaryTable>

getOrCreatePrimaryKeyJoinColumn

PrimaryKeyJoinColumn<Entity<T>> getOrCreatePrimaryKeyJoinColumn()
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.

Returns:
the instance defined for the element primary-key-join-column

createPrimaryKeyJoinColumn

PrimaryKeyJoinColumn<Entity<T>> createPrimaryKeyJoinColumn()
Creates a new primary-key-join-column element

Returns:
the new created instance of PrimaryKeyJoinColumn>

getAllPrimaryKeyJoinColumn

List<PrimaryKeyJoinColumn<Entity<T>>> getAllPrimaryKeyJoinColumn()
Returns all primary-key-join-column elements

Returns:
list of primary-key-join-column

removeAllPrimaryKeyJoinColumn

Entity<T> removeAllPrimaryKeyJoinColumn()
Removes all primary-key-join-column elements

Returns:
the current instance of PrimaryKeyJoinColumn>

getOrCreateIdClass

IdClass<Entity<T>> getOrCreateIdClass()
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.

Returns:
a new or existing instance of IdClass>

removeIdClass

Entity<T> removeIdClass()
Removes the id-class element

Returns:
the current instance of Entity

getOrCreateInheritance

Inheritance<Entity<T>> getOrCreateInheritance()
If not already created, a new inheritance element with the given value will be created. Otherwise, the existing inheritance element will be returned.

Returns:
a new or existing instance of Inheritance>

removeInheritance

Entity<T> removeInheritance()
Removes the inheritance element

Returns:
the current instance of Entity

discriminatorValue

Entity<T> discriminatorValue(String discriminatorValue)
Sets the discriminator-value element

Parameters:
discriminatorValue - the value for the element discriminator-value
Returns:
the current instance of Entity

getDiscriminatorValue

String getDiscriminatorValue()
Returns the discriminator-value element

Returns:
the node defined for the element discriminator-value

removeDiscriminatorValue

Entity<T> removeDiscriminatorValue()
Removes the discriminator-value element

Returns:
the current instance of Entity

getOrCreateDiscriminatorColumn

DiscriminatorColumn<Entity<T>> getOrCreateDiscriminatorColumn()
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.

Returns:
a new or existing instance of DiscriminatorColumn>

removeDiscriminatorColumn

Entity<T> removeDiscriminatorColumn()
Removes the discriminator-column element

Returns:
the current instance of Entity

getOrCreateSequenceGenerator

SequenceGenerator<Entity<T>> getOrCreateSequenceGenerator()
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.

Returns:
a new or existing instance of SequenceGenerator>

removeSequenceGenerator

Entity<T> removeSequenceGenerator()
Removes the sequence-generator element

Returns:
the current instance of Entity

getOrCreateTableGenerator

TableGenerator<Entity<T>> getOrCreateTableGenerator()
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.

Returns:
a new or existing instance of TableGenerator>

removeTableGenerator

Entity<T> removeTableGenerator()
Removes the table-generator element

Returns:
the current instance of Entity

getOrCreateNamedQuery

NamedQuery<Entity<T>> getOrCreateNamedQuery()
If not already created, a new named-query element will be created and returned. Otherwise, the first existing named-query element will be returned.

Returns:
the instance defined for the element named-query

createNamedQuery

NamedQuery<Entity<T>> createNamedQuery()
Creates a new named-query element

Returns:
the new created instance of NamedQuery>

getAllNamedQuery

List<NamedQuery<Entity<T>>> getAllNamedQuery()
Returns all named-query elements

Returns:
list of named-query

removeAllNamedQuery

Entity<T> removeAllNamedQuery()
Removes all named-query elements

Returns:
the current instance of NamedQuery>

getOrCreateNamedNativeQuery

NamedNativeQuery<Entity<T>> getOrCreateNamedNativeQuery()
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.

Returns:
the instance defined for the element named-native-query

createNamedNativeQuery

NamedNativeQuery<Entity<T>> createNamedNativeQuery()
Creates a new named-native-query element

Returns:
the new created instance of NamedNativeQuery>

getAllNamedNativeQuery

List<NamedNativeQuery<Entity<T>>> getAllNamedNativeQuery()
Returns all named-native-query elements

Returns:
list of named-native-query

removeAllNamedNativeQuery

Entity<T> removeAllNamedNativeQuery()
Removes all named-native-query elements

Returns:
the current instance of NamedNativeQuery>

getOrCreateSqlResultSetMapping

SqlResultSetMapping<Entity<T>> getOrCreateSqlResultSetMapping()
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.

Returns:
the instance defined for the element sql-result-set-mapping

createSqlResultSetMapping

SqlResultSetMapping<Entity<T>> createSqlResultSetMapping()
Creates a new sql-result-set-mapping element

Returns:
the new created instance of SqlResultSetMapping>

getAllSqlResultSetMapping

List<SqlResultSetMapping<Entity<T>>> getAllSqlResultSetMapping()
Returns all sql-result-set-mapping elements

Returns:
list of sql-result-set-mapping

removeAllSqlResultSetMapping

Entity<T> removeAllSqlResultSetMapping()
Removes all sql-result-set-mapping elements

Returns:
the current instance of SqlResultSetMapping>

excludeDefaultListeners

Entity<T> excludeDefaultListeners()
Sets the exclude-default-listeners element

Returns:
the current instance of Entity

isExcludeDefaultListeners

Boolean isExcludeDefaultListeners()
Removes the exclude-default-listeners element

Returns:
the current instance of Entity

removeExcludeDefaultListeners

Entity<T> removeExcludeDefaultListeners()
Removes the exclude-default-listeners element

Returns:
the current instance of Entity

excludeSuperclassListeners

Entity<T> excludeSuperclassListeners()
Sets the exclude-superclass-listeners element

Returns:
the current instance of Entity

isExcludeSuperclassListeners

Boolean isExcludeSuperclassListeners()
Removes the exclude-superclass-listeners element

Returns:
the current instance of Entity

removeExcludeSuperclassListeners

Entity<T> removeExcludeSuperclassListeners()
Removes the exclude-superclass-listeners element

Returns:
the current instance of Entity

getOrCreateEntityListeners

EntityListeners<Entity<T>> getOrCreateEntityListeners()
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.

Returns:
a new or existing instance of EntityListeners>

removeEntityListeners

Entity<T> removeEntityListeners()
Removes the entity-listeners element

Returns:
the current instance of Entity

getOrCreatePrePersist

PrePersist<Entity<T>> getOrCreatePrePersist()
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.

Returns:
a new or existing instance of PrePersist>

removePrePersist

Entity<T> removePrePersist()
Removes the pre-persist element

Returns:
the current instance of Entity

getOrCreatePostPersist

PostPersist<Entity<T>> getOrCreatePostPersist()
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.

Returns:
a new or existing instance of PostPersist>

removePostPersist

Entity<T> removePostPersist()
Removes the post-persist element

Returns:
the current instance of Entity

getOrCreatePreRemove

PreRemove<Entity<T>> getOrCreatePreRemove()
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.

Returns:
a new or existing instance of PreRemove>

removePreRemove

Entity<T> removePreRemove()
Removes the pre-remove element

Returns:
the current instance of Entity

getOrCreatePostRemove

PostRemove<Entity<T>> getOrCreatePostRemove()
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.

Returns:
a new or existing instance of PostRemove>

removePostRemove

Entity<T> removePostRemove()
Removes the post-remove element

Returns:
the current instance of Entity

getOrCreatePreUpdate

PreUpdate<Entity<T>> getOrCreatePreUpdate()
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.

Returns:
a new or existing instance of PreUpdate>

removePreUpdate

Entity<T> removePreUpdate()
Removes the pre-update element

Returns:
the current instance of Entity

getOrCreatePostUpdate

PostUpdate<Entity<T>> getOrCreatePostUpdate()
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.

Returns:
a new or existing instance of PostUpdate>

removePostUpdate

Entity<T> removePostUpdate()
Removes the post-update element

Returns:
the current instance of Entity

getOrCreatePostLoad

PostLoad<Entity<T>> getOrCreatePostLoad()
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.

Returns:
a new or existing instance of PostLoad>

removePostLoad

Entity<T> removePostLoad()
Removes the post-load element

Returns:
the current instance of Entity

getOrCreateAttributeOverride

AttributeOverride<Entity<T>> getOrCreateAttributeOverride()
If not already created, a new attribute-override element will be created and returned. Otherwise, the first existing attribute-override element will be returned.

Returns:
the instance defined for the element attribute-override

createAttributeOverride

AttributeOverride<Entity<T>> createAttributeOverride()
Creates a new attribute-override element

Returns:
the new created instance of AttributeOverride>

getAllAttributeOverride

List<AttributeOverride<Entity<T>>> getAllAttributeOverride()
Returns all attribute-override elements

Returns:
list of attribute-override

removeAllAttributeOverride

Entity<T> removeAllAttributeOverride()
Removes all attribute-override elements

Returns:
the current instance of AttributeOverride>

getOrCreateAssociationOverride

AssociationOverride<Entity<T>> getOrCreateAssociationOverride()
If not already created, a new association-override element will be created and returned. Otherwise, the first existing association-override element will be returned.

Returns:
the instance defined for the element association-override

createAssociationOverride

AssociationOverride<Entity<T>> createAssociationOverride()
Creates a new association-override element

Returns:
the new created instance of AssociationOverride>

getAllAssociationOverride

List<AssociationOverride<Entity<T>>> getAllAssociationOverride()
Returns all association-override elements

Returns:
list of association-override

removeAllAssociationOverride

Entity<T> removeAllAssociationOverride()
Removes all association-override elements

Returns:
the current instance of AssociationOverride>

getOrCreateAttributes

Attributes<Entity<T>> getOrCreateAttributes()
If not already created, a new attributes element with the given value will be created. Otherwise, the existing attributes element will be returned.

Returns:
a new or existing instance of Attributes>

removeAttributes

Entity<T> removeAttributes()
Removes the attributes element

Returns:
the current instance of Entity

name

Entity<T> name(String name)
Sets the name attribute

Parameters:
name - the value for the attribute name
Returns:
the current instance of Entity

getName

String getName()
Returns the name attribute

Returns:
the value defined for the attribute name

removeName

Entity<T> removeName()
Removes the name attribute

Returns:
the current instance of Entity

clazz

Entity<T> clazz(String clazz)
Sets the class attribute

Parameters:
clazz - the value for the attribute class
Returns:
the current instance of Entity

getClazz

String getClazz()
Returns the class attribute

Returns:
the value defined for the attribute class

removeClazz

Entity<T> removeClazz()
Removes the class attribute

Returns:
the current instance of Entity

access

Entity<T> access(AccessType access)
Sets the access attribute

Parameters:
access - the value for the attribute access
Returns:
the current instance of Entity

access

Entity<T> access(String access)
Sets the access attribute

Parameters:
access - the value for the attribute access
Returns:
the current instance of Entity

getAccess

AccessType getAccess()
Returns the access attribute

Returns:
the value defined for the attribute access

getAccessAsString

String getAccessAsString()
Returns the access attribute

Returns:
the value found for the element access

removeAccess

Entity<T> removeAccess()
Removes the access attribute

Returns:
the current instance of Entity

cacheable

Entity<T> cacheable(Boolean cacheable)
Sets the cacheable attribute

Parameters:
cacheable - the value for the attribute cacheable
Returns:
the current instance of Entity

isCacheable

Boolean isCacheable()
Returns the cacheable attribute

Returns:
the value defined for the attribute cacheable

removeCacheable

Entity<T> removeCacheable()
Removes the cacheable attribute

Returns:
the current instance of Entity

metadataComplete

Entity<T> metadataComplete(Boolean metadataComplete)
Sets the metadata-complete attribute

Parameters:
metadataComplete - the value for the attribute metadata-complete
Returns:
the current instance of Entity

isMetadataComplete

Boolean isMetadataComplete()
Returns the metadata-complete attribute

Returns:
the value defined for the attribute metadata-complete

removeMetadataComplete

Entity<T> removeMetadataComplete()
Removes the metadata-complete attribute

Returns:
the current instance of Entity

ShrinkWrap Descriptors Generated Java EE API 2.0.0-alpha-3

Copyright © 2012 JBoss by Red Hat. All Rights Reserved.