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

All Superinterfaces:

Child<T>

public interface AssociationOverride<T>
extends Child<T>

This interface defines the contract for the association-override xsd type

Since:

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

Author:

Ralf Battenfeld, Andrew Lee Rubinger

Method Summary

JoinColumn<AssociationOverride<T>>	createJoinColumn() Creates a new join-column element
AssociationOverride<T>	description(String description) Sets the description element
List<JoinColumn<AssociationOverride<T>>>	getAllJoinColumn() Returns all join-column elements
String	getDescription() Returns the description element
String	getName() Returns the name attribute
JoinColumn<AssociationOverride<T>>	getOrCreateJoinColumn() If not already created, a new join-column element will be created and returned.
JoinTable<AssociationOverride<T>>	getOrCreateJoinTable() If not already created, a new join-table element with the given value will be created.
AssociationOverride<T>	name(String name) Sets the name attribute
AssociationOverride<T>	removeAllJoinColumn() Removes all join-column elements
AssociationOverride<T>	removeDescription() Removes the description element
AssociationOverride<T>	removeJoinTable() Removes the join-table element
AssociationOverride<T>	removeName() Removes the name attribute

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

up

Method Detail

description

AssociationOverride<T> description(String description)

Sets the description element

Parameters:

description - the value for the element description

Returns:

the current instance of AssociationOverride

getDescription

String getDescription()

Returns the description element

Returns:

the node defined for the element description

removeDescription

AssociationOverride<T> removeDescription()

Removes the description element

Returns:

the current instance of AssociationOverride

getOrCreateJoinColumn

JoinColumn<AssociationOverride<T>> getOrCreateJoinColumn()

If not already created, a new join-column element will be created and returned. Otherwise, the first existing join-column element will be returned.

Returns:

the instance defined for the element join-column

createJoinColumn

JoinColumn<AssociationOverride<T>> createJoinColumn()

Creates a new join-column element

Returns:

the new created instance of JoinColumn>

getAllJoinColumn

List<JoinColumn<AssociationOverride<T>>> getAllJoinColumn()

Returns all join-column elements

Returns:

list of join-column

removeAllJoinColumn

AssociationOverride<T> removeAllJoinColumn()

Removes all join-column elements

Returns:

the current instance of JoinColumn>

getOrCreateJoinTable

JoinTable<AssociationOverride<T>> getOrCreateJoinTable()

If not already created, a new join-table element with the given value will be created. Otherwise, the existing join-table element will be returned.

Returns:

a new or existing instance of JoinTable>

removeJoinTable

AssociationOverride<T> removeJoinTable()

Removes the join-table element

Returns:

the current instance of AssociationOverride

name

AssociationOverride<T> name(String name)

Sets the name attribute

Parameters:

name - the value for the attribute name

Returns:

the current instance of AssociationOverride

getName

String getName()

Returns the name attribute

Returns:

the value defined for the attribute name

removeName

AssociationOverride<T> removeName()

Removes the name attribute

Returns:

the current instance of AssociationOverride