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

All Superinterfaces:

Child<T>

public interface MappedSuperclass<T>
extends Child<T>

This interface defines the contract for the mapped-superclass xsd type

Since:

Generation date :2012-05-09T23:45:05.33-07:00

Author:

Ralf Battenfeld, Andrew Lee Rubinger

Method Summary

MappedSuperclass<T>	access(AccessType access) Sets the access attribute
MappedSuperclass<T>	access(String access) Sets the access attribute
MappedSuperclass<T>	clazz(String clazz) Sets the class attribute
MappedSuperclass<T>	description(String description) Sets the description element
MappedSuperclass<T>	excludeDefaultListeners() Sets the exclude-default-listeners element
MappedSuperclass<T>	excludeSuperclassListeners() Sets the exclude-superclass-listeners element
AccessType	getAccess() Returns the access attribute
String	getAccessAsString() Returns the access attribute
String	getClazz() Returns the class attribute
String	getDescription() Returns the description element
Attributes<MappedSuperclass<T>>	getOrCreateAttributes() If not already created, a new attributes element with the given value will be created.
EntityListeners<MappedSuperclass<T>>	getOrCreateEntityListeners() If not already created, a new entity-listeners element with the given value will be created.
IdClass<MappedSuperclass<T>>	getOrCreateIdClass() If not already created, a new id-class element with the given value will be created.
PostLoad<MappedSuperclass<T>>	getOrCreatePostLoad() If not already created, a new post-load element with the given value will be created.
PostPersist<MappedSuperclass<T>>	getOrCreatePostPersist() If not already created, a new post-persist element with the given value will be created.
PostRemove<MappedSuperclass<T>>	getOrCreatePostRemove() If not already created, a new post-remove element with the given value will be created.
PostUpdate<MappedSuperclass<T>>	getOrCreatePostUpdate() If not already created, a new post-update element with the given value will be created.
PrePersist<MappedSuperclass<T>>	getOrCreatePrePersist() If not already created, a new pre-persist element with the given value will be created.
PreRemove<MappedSuperclass<T>>	getOrCreatePreRemove() If not already created, a new pre-remove element with the given value will be created.
PreUpdate<MappedSuperclass<T>>	getOrCreatePreUpdate() If not already created, a new pre-update element with the given value will be created.
Boolean	isExcludeDefaultListeners() Removes the exclude-default-listeners element
Boolean	isExcludeSuperclassListeners() Removes the exclude-superclass-listeners element
Boolean	isMetadataComplete() Returns the metadata-complete attribute
MappedSuperclass<T>	metadataComplete(Boolean metadataComplete) Sets the metadata-complete attribute
MappedSuperclass<T>	removeAccess() Removes the access attribute
MappedSuperclass<T>	removeAttributes() Removes the attributes element
MappedSuperclass<T>	removeClazz() Removes the class attribute
MappedSuperclass<T>	removeDescription() Removes the description element
MappedSuperclass<T>	removeEntityListeners() Removes the entity-listeners element
MappedSuperclass<T>	removeExcludeDefaultListeners() Removes the exclude-default-listeners element
MappedSuperclass<T>	removeExcludeSuperclassListeners() Removes the exclude-superclass-listeners element
MappedSuperclass<T>	removeIdClass() Removes the id-class element
MappedSuperclass<T>	removeMetadataComplete() Removes the metadata-complete attribute
MappedSuperclass<T>	removePostLoad() Removes the post-load element
MappedSuperclass<T>	removePostPersist() Removes the post-persist element
MappedSuperclass<T>	removePostRemove() Removes the post-remove element
MappedSuperclass<T>	removePostUpdate() Removes the post-update element
MappedSuperclass<T>	removePrePersist() Removes the pre-persist element
MappedSuperclass<T>	removePreRemove() Removes the pre-remove element
MappedSuperclass<T>	removePreUpdate() Removes the pre-update element

Methods inherited from interface org.jboss.shrinkwrap.descriptor.api.Child

up

Method Detail

description

MappedSuperclass<T> description(String description)

Sets the description element

Parameters:

description - the value for the element description

Returns:

the current instance of MappedSuperclass

getDescription

String getDescription()

Returns the description element

Returns:

the node defined for the element description

removeDescription

MappedSuperclass<T> removeDescription()

Removes the description element

Returns:

the current instance of MappedSuperclass

getOrCreateIdClass

IdClass<MappedSuperclass<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

MappedSuperclass<T> removeIdClass()

Removes the id-class element

Returns:

the current instance of MappedSuperclass

excludeDefaultListeners

MappedSuperclass<T> excludeDefaultListeners()

Sets the exclude-default-listeners element

Returns:

the current instance of MappedSuperclass

isExcludeDefaultListeners

Boolean isExcludeDefaultListeners()

Removes the exclude-default-listeners element

Returns:

the current instance of MappedSuperclass

removeExcludeDefaultListeners

MappedSuperclass<T> removeExcludeDefaultListeners()

Removes the exclude-default-listeners element

Returns:

the current instance of MappedSuperclass

excludeSuperclassListeners

MappedSuperclass<T> excludeSuperclassListeners()

Sets the exclude-superclass-listeners element

Returns:

the current instance of MappedSuperclass

isExcludeSuperclassListeners

Boolean isExcludeSuperclassListeners()

Removes the exclude-superclass-listeners element

Returns:

the current instance of MappedSuperclass

removeExcludeSuperclassListeners

MappedSuperclass<T> removeExcludeSuperclassListeners()

Removes the exclude-superclass-listeners element

Returns:

the current instance of MappedSuperclass

getOrCreateEntityListeners

EntityListeners<MappedSuperclass<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

MappedSuperclass<T> removeEntityListeners()

Removes the entity-listeners element

Returns:

the current instance of MappedSuperclass

getOrCreatePrePersist

PrePersist<MappedSuperclass<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

MappedSuperclass<T> removePrePersist()

Removes the pre-persist element

Returns:

the current instance of MappedSuperclass

getOrCreatePostPersist

PostPersist<MappedSuperclass<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

MappedSuperclass<T> removePostPersist()

Removes the post-persist element

Returns:

the current instance of MappedSuperclass

getOrCreatePreRemove

PreRemove<MappedSuperclass<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

MappedSuperclass<T> removePreRemove()

Removes the pre-remove element

Returns:

the current instance of MappedSuperclass

getOrCreatePostRemove

PostRemove<MappedSuperclass<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

MappedSuperclass<T> removePostRemove()

Removes the post-remove element

Returns:

the current instance of MappedSuperclass

getOrCreatePreUpdate

PreUpdate<MappedSuperclass<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

MappedSuperclass<T> removePreUpdate()

Removes the pre-update element

Returns:

the current instance of MappedSuperclass

getOrCreatePostUpdate

PostUpdate<MappedSuperclass<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

MappedSuperclass<T> removePostUpdate()

Removes the post-update element

Returns:

the current instance of MappedSuperclass

getOrCreatePostLoad

PostLoad<MappedSuperclass<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

MappedSuperclass<T> removePostLoad()

Removes the post-load element

Returns:

the current instance of MappedSuperclass

getOrCreateAttributes

Attributes<MappedSuperclass<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

MappedSuperclass<T> removeAttributes()

Removes the attributes element

Returns:

the current instance of MappedSuperclass

clazz

MappedSuperclass<T> clazz(String clazz)

Sets the class attribute

Parameters:

clazz - the value for the attribute class

Returns:

the current instance of MappedSuperclass

getClazz

String getClazz()

Returns the class attribute

Returns:

the value defined for the attribute class

removeClazz

MappedSuperclass<T> removeClazz()

Removes the class attribute

Returns:

the current instance of MappedSuperclass

access

MappedSuperclass<T> access(AccessType access)

Sets the access attribute

Parameters:

access - the value for the attribute access

Returns:

the current instance of MappedSuperclass

access

MappedSuperclass<T> access(String access)

Sets the access attribute

Parameters:

access - the value for the attribute access

Returns:

the current instance of MappedSuperclass

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

MappedSuperclass<T> removeAccess()

Removes the access attribute

Returns:

the current instance of MappedSuperclass

metadataComplete

MappedSuperclass<T> metadataComplete(Boolean metadataComplete)

Sets the metadata-complete attribute

Parameters:

metadataComplete - the value for the attribute metadata-complete

Returns:

the current instance of MappedSuperclass

isMetadataComplete

Boolean isMetadataComplete()

Returns the metadata-complete attribute

Returns:

the value defined for the attribute metadata-complete

removeMetadataComplete

MappedSuperclass<T> removeMetadataComplete()

Removes the metadata-complete attribute

Returns:

the current instance of MappedSuperclass