org.jboss.shrinkwrap.descriptor.api.orm10
Interface ManyToOne<T>

All Superinterfaces:

Child<T>

public interface ManyToOne<T>
extends Child<T>

This interface defines the contract for the many-to-one xsd type

Since:

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

Author:

Ralf Battenfeld, Andrew Lee Rubinger

Method Summary

JoinColumn<ManyToOne<T>>	createJoinColumn() Creates a new join-column element
ManyToOne<T>	fetch(FetchType fetch) Sets the fetch attribute
ManyToOne<T>	fetch(String fetch) Sets the fetch attribute
List<JoinColumn<ManyToOne<T>>>	getAllJoinColumn() Returns all join-column elements
FetchType	getFetch() Returns the fetch attribute
String	getFetchAsString() Returns the fetch attribute
String	getName() Returns the name attribute
CascadeType<ManyToOne<T>>	getOrCreateCascade() If not already created, a new cascade element with the given value will be created.
JoinColumn<ManyToOne<T>>	getOrCreateJoinColumn() If not already created, a new join-column element will be created and returned.
JoinTable<ManyToOne<T>>	getOrCreateJoinTable() If not already created, a new join-table element with the given value will be created.
String	getTargetEntity() Returns the target-entity attribute
Boolean	isOptional() Returns the optional attribute
ManyToOne<T>	name(String name) Sets the name attribute
ManyToOne<T>	optional(Boolean optional) Sets the optional attribute
ManyToOne<T>	removeAllJoinColumn() Removes all join-column elements
ManyToOne<T>	removeCascade() Removes the cascade element
ManyToOne<T>	removeFetch() Removes the fetch attribute
ManyToOne<T>	removeJoinTable() Removes the join-table element
ManyToOne<T>	removeName() Removes the name attribute
ManyToOne<T>	removeOptional() Removes the optional attribute
ManyToOne<T>	removeTargetEntity() Removes the target-entity attribute
ManyToOne<T>	targetEntity(String targetEntity) Sets the target-entity attribute

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

up

Method Detail

getOrCreateJoinColumn

JoinColumn<ManyToOne<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<ManyToOne<T>> createJoinColumn()

Creates a new join-column element

Returns:

the new created instance of JoinColumn>

getAllJoinColumn

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

Returns all join-column elements

Returns:

list of join-column

removeAllJoinColumn

ManyToOne<T> removeAllJoinColumn()

Removes all join-column elements

Returns:

the current instance of JoinColumn>

getOrCreateJoinTable

JoinTable<ManyToOne<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

ManyToOne<T> removeJoinTable()

Removes the join-table element

Returns:

the current instance of ManyToOne

getOrCreateCascade

CascadeType<ManyToOne<T>> getOrCreateCascade()

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

Returns:

a new or existing instance of CascadeType>

removeCascade

ManyToOne<T> removeCascade()

Removes the cascade element

Returns:

the current instance of ManyToOne

name

ManyToOne<T> name(String name)

Sets the name attribute

Parameters:

name - the value for the attribute name

Returns:

the current instance of ManyToOne

getName

String getName()

Returns the name attribute

Returns:

the value defined for the attribute name

removeName

ManyToOne<T> removeName()

Removes the name attribute

Returns:

the current instance of ManyToOne

targetEntity

ManyToOne<T> targetEntity(String targetEntity)

Sets the target-entity attribute

Parameters:

targetEntity - the value for the attribute target-entity

Returns:

the current instance of ManyToOne

getTargetEntity

String getTargetEntity()

Returns the target-entity attribute

Returns:

the value defined for the attribute target-entity

removeTargetEntity

ManyToOne<T> removeTargetEntity()

Removes the target-entity attribute

Returns:

the current instance of ManyToOne

fetch

ManyToOne<T> fetch(FetchType fetch)

Sets the fetch attribute

Parameters:

fetch - the value for the attribute fetch

Returns:

the current instance of ManyToOne

fetch

ManyToOne<T> fetch(String fetch)

Sets the fetch attribute

Parameters:

fetch - the value for the attribute fetch

Returns:

the current instance of ManyToOne

getFetch

FetchType getFetch()

Returns the fetch attribute

Returns:

the value defined for the attribute fetch

getFetchAsString

String getFetchAsString()

Returns the fetch attribute

Returns:

the value found for the element fetch

removeFetch

ManyToOne<T> removeFetch()

Removes the fetch attribute

Returns:

the current instance of ManyToOne

optional

ManyToOne<T> optional(Boolean optional)

Sets the optional attribute

Parameters:

optional - the value for the attribute optional

Returns:

the current instance of ManyToOne

isOptional

Boolean isOptional()

Returns the optional attribute

Returns:

the value defined for the attribute optional

removeOptional

ManyToOne<T> removeOptional()

Removes the optional attribute

Returns:

the current instance of ManyToOne