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

All Superinterfaces:
Child<T>

public interface ManyToMany<T>
extends Child<T>

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

Since:
Generation date :2013-01-26T19:26:59.858+01:00
Author:
Ralf Battenfeld, Andrew Lee Rubinger

Method Summary
 ManyToMany<T> access(AccessType access)
          Sets the access attribute
 ManyToMany<T> access(String access)
          Sets the access attribute
 AttributeOverride<ManyToMany<T>> createMapKeyAttributeOverride()
          Creates a new map-key-attribute-override element
 MapKeyJoinColumn<ManyToMany<T>> createMapKeyJoinColumn()
          Creates a new map-key-join-column element
 ManyToMany<T> fetch(FetchType fetch)
          Sets the fetch attribute
 ManyToMany<T> fetch(String fetch)
          Sets the fetch attribute
 AccessType getAccess()
          Returns the access attribute
 String getAccessAsString()
          Returns the access attribute
 List<AttributeOverride<ManyToMany<T>>> getAllMapKeyAttributeOverride()
          Returns all map-key-attribute-override elements
 List<MapKeyJoinColumn<ManyToMany<T>>> getAllMapKeyJoinColumn()
          Returns all map-key-join-column elements
 FetchType getFetch()
          Returns the fetch attribute
 String getFetchAsString()
          Returns the fetch attribute
 EnumType getMapKeyEnumerated()
          Returns the map-key-enumerated element
 String getMapKeyEnumeratedAsString()
          Returns the map-key-enumerated element
 TemporalType getMapKeyTemporal()
          Returns the map-key-temporal element
 String getMapKeyTemporalAsString()
          Returns the map-key-temporal element
 String getMappedBy()
          Returns the mapped-by attribute
 String getName()
          Returns the name attribute
 CascadeType<ManyToMany<T>> getOrCreateCascade()
          If not already created, a new cascade element with the given value will be created.
 JoinTable<ManyToMany<T>> getOrCreateJoinTable()
          If not already created, a new join-table element with the given value will be created.
 MapKey<ManyToMany<T>> getOrCreateMapKey()
          If not already created, a new map-key element with the given value will be created.
 AttributeOverride<ManyToMany<T>> getOrCreateMapKeyAttributeOverride()
          If not already created, a new map-key-attribute-override element will be created and returned.
 MapKeyClass<ManyToMany<T>> getOrCreateMapKeyClass()
          If not already created, a new map-key-class element with the given value will be created.
 MapKeyColumn<ManyToMany<T>> getOrCreateMapKeyColumn()
          If not already created, a new map-key-column element with the given value will be created.
 MapKeyJoinColumn<ManyToMany<T>> getOrCreateMapKeyJoinColumn()
          If not already created, a new map-key-join-column element will be created and returned.
 OrderColumn<ManyToMany<T>> getOrCreateOrderColumn()
          If not already created, a new order-column element with the given value will be created.
 String getOrderBy()
          Returns the order-by element
 String getTargetEntity()
          Returns the target-entity attribute
 ManyToMany<T> mapKeyEnumerated(EnumType mapKeyEnumerated)
          Sets the map-key-enumerated element
 ManyToMany<T> mapKeyEnumerated(String mapKeyEnumerated)
          Sets the map-key-enumerated element
 ManyToMany<T> mapKeyTemporal(String mapKeyTemporal)
          Sets the map-key-temporal element
 ManyToMany<T> mapKeyTemporal(TemporalType mapKeyTemporal)
          Sets the map-key-temporal element
 ManyToMany<T> mappedBy(String mappedBy)
          Sets the mapped-by attribute
 ManyToMany<T> name(String name)
          Sets the name attribute
 ManyToMany<T> orderBy(String orderBy)
          Sets the order-by element
 ManyToMany<T> removeAccess()
          Removes the access attribute
 ManyToMany<T> removeAllMapKeyAttributeOverride()
          Removes all map-key-attribute-override elements
 ManyToMany<T> removeAllMapKeyJoinColumn()
          Removes all map-key-join-column elements
 ManyToMany<T> removeCascade()
          Removes the cascade element
 ManyToMany<T> removeFetch()
          Removes the fetch attribute
 ManyToMany<T> removeJoinTable()
          Removes the join-table element
 ManyToMany<T> removeMapKey()
          Removes the map-key element
 ManyToMany<T> removeMapKeyClass()
          Removes the map-key-class element
 ManyToMany<T> removeMapKeyColumn()
          Removes the map-key-column element
 ManyToMany<T> removeMapKeyEnumerated()
          Removes the map-key-enumerated attribute
 ManyToMany<T> removeMapKeyTemporal()
          Removes the map-key-temporal attribute
 ManyToMany<T> removeMappedBy()
          Removes the mapped-by attribute
 ManyToMany<T> removeName()
          Removes the name attribute
 ManyToMany<T> removeOrderBy()
          Removes the order-by element
 ManyToMany<T> removeOrderColumn()
          Removes the order-column element
 ManyToMany<T> removeTargetEntity()
          Removes the target-entity attribute
 ManyToMany<T> targetEntity(String targetEntity)
          Sets the target-entity attribute
 
Methods inherited from interface org.jboss.shrinkwrap.descriptor.api.Child
up
 

Method Detail

orderBy

ManyToMany<T> orderBy(String orderBy)
Sets the order-by element

Parameters:
orderBy - the value for the element order-by
Returns:
the current instance of ManyToMany

getOrderBy

String getOrderBy()
Returns the order-by element

Returns:
the node defined for the element order-by

removeOrderBy

ManyToMany<T> removeOrderBy()
Removes the order-by element

Returns:
the current instance of ManyToMany

getOrCreateOrderColumn

OrderColumn<ManyToMany<T>> getOrCreateOrderColumn()
If not already created, a new order-column element with the given value will be created. Otherwise, the existing order-column element will be returned.

Returns:
a new or existing instance of OrderColumn>

removeOrderColumn

ManyToMany<T> removeOrderColumn()
Removes the order-column element

Returns:
the current instance of ManyToMany

getOrCreateMapKey

MapKey<ManyToMany<T>> getOrCreateMapKey()
If not already created, a new map-key element with the given value will be created. Otherwise, the existing map-key element will be returned.

Returns:
a new or existing instance of MapKey>

removeMapKey

ManyToMany<T> removeMapKey()
Removes the map-key element

Returns:
the current instance of ManyToMany

getOrCreateMapKeyClass

MapKeyClass<ManyToMany<T>> getOrCreateMapKeyClass()
If not already created, a new map-key-class element with the given value will be created. Otherwise, the existing map-key-class element will be returned.

Returns:
a new or existing instance of MapKeyClass>

removeMapKeyClass

ManyToMany<T> removeMapKeyClass()
Removes the map-key-class element

Returns:
the current instance of ManyToMany

mapKeyTemporal

ManyToMany<T> mapKeyTemporal(TemporalType mapKeyTemporal)
Sets the map-key-temporal element

Parameters:
mapKeyTemporal - the value for the element map-key-temporal
Returns:
the current instance of ManyToMany

mapKeyTemporal

ManyToMany<T> mapKeyTemporal(String mapKeyTemporal)
Sets the map-key-temporal element

Parameters:
mapKeyTemporal - the value for the element map-key-temporal
Returns:
the current instance of ManyToMany

getMapKeyTemporal

TemporalType getMapKeyTemporal()
Returns the map-key-temporal element

Returns:
the value found for the element map-key-temporal

getMapKeyTemporalAsString

String getMapKeyTemporalAsString()
Returns the map-key-temporal element

Returns:
the value found for the element map-key-temporal

removeMapKeyTemporal

ManyToMany<T> removeMapKeyTemporal()
Removes the map-key-temporal attribute

Returns:
the current instance of ManyToMany

mapKeyEnumerated

ManyToMany<T> mapKeyEnumerated(EnumType mapKeyEnumerated)
Sets the map-key-enumerated element

Parameters:
mapKeyEnumerated - the value for the element map-key-enumerated
Returns:
the current instance of ManyToMany

mapKeyEnumerated

ManyToMany<T> mapKeyEnumerated(String mapKeyEnumerated)
Sets the map-key-enumerated element

Parameters:
mapKeyEnumerated - the value for the element map-key-enumerated
Returns:
the current instance of ManyToMany

getMapKeyEnumerated

EnumType getMapKeyEnumerated()
Returns the map-key-enumerated element

Returns:
the value found for the element map-key-enumerated

getMapKeyEnumeratedAsString

String getMapKeyEnumeratedAsString()
Returns the map-key-enumerated element

Returns:
the value found for the element map-key-enumerated

removeMapKeyEnumerated

ManyToMany<T> removeMapKeyEnumerated()
Removes the map-key-enumerated attribute

Returns:
the current instance of ManyToMany

getOrCreateMapKeyAttributeOverride

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

Returns:
the instance defined for the element map-key-attribute-override

createMapKeyAttributeOverride

AttributeOverride<ManyToMany<T>> createMapKeyAttributeOverride()
Creates a new map-key-attribute-override element

Returns:
the new created instance of AttributeOverride>

getAllMapKeyAttributeOverride

List<AttributeOverride<ManyToMany<T>>> getAllMapKeyAttributeOverride()
Returns all map-key-attribute-override elements

Returns:
list of map-key-attribute-override

removeAllMapKeyAttributeOverride

ManyToMany<T> removeAllMapKeyAttributeOverride()
Removes all map-key-attribute-override elements

Returns:
the current instance of AttributeOverride>

getOrCreateMapKeyColumn

MapKeyColumn<ManyToMany<T>> getOrCreateMapKeyColumn()
If not already created, a new map-key-column element with the given value will be created. Otherwise, the existing map-key-column element will be returned.

Returns:
a new or existing instance of MapKeyColumn>

removeMapKeyColumn

ManyToMany<T> removeMapKeyColumn()
Removes the map-key-column element

Returns:
the current instance of ManyToMany

getOrCreateMapKeyJoinColumn

MapKeyJoinColumn<ManyToMany<T>> getOrCreateMapKeyJoinColumn()
If not already created, a new map-key-join-column element will be created and returned. Otherwise, the first existing map-key-join-column element will be returned.

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

createMapKeyJoinColumn

MapKeyJoinColumn<ManyToMany<T>> createMapKeyJoinColumn()
Creates a new map-key-join-column element

Returns:
the new created instance of MapKeyJoinColumn>

getAllMapKeyJoinColumn

List<MapKeyJoinColumn<ManyToMany<T>>> getAllMapKeyJoinColumn()
Returns all map-key-join-column elements

Returns:
list of map-key-join-column

removeAllMapKeyJoinColumn

ManyToMany<T> removeAllMapKeyJoinColumn()
Removes all map-key-join-column elements

Returns:
the current instance of MapKeyJoinColumn>

getOrCreateJoinTable

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

ManyToMany<T> removeJoinTable()
Removes the join-table element

Returns:
the current instance of ManyToMany

getOrCreateCascade

CascadeType<ManyToMany<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

ManyToMany<T> removeCascade()
Removes the cascade element

Returns:
the current instance of ManyToMany

name

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

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

getName

String getName()
Returns the name attribute

Returns:
the value defined for the attribute name

removeName

ManyToMany<T> removeName()
Removes the name attribute

Returns:
the current instance of ManyToMany

targetEntity

ManyToMany<T> targetEntity(String targetEntity)
Sets the target-entity attribute

Parameters:
targetEntity - the value for the attribute target-entity
Returns:
the current instance of ManyToMany

getTargetEntity

String getTargetEntity()
Returns the target-entity attribute

Returns:
the value defined for the attribute target-entity

removeTargetEntity

ManyToMany<T> removeTargetEntity()
Removes the target-entity attribute

Returns:
the current instance of ManyToMany

fetch

ManyToMany<T> fetch(FetchType fetch)
Sets the fetch attribute

Parameters:
fetch - the value for the attribute fetch
Returns:
the current instance of ManyToMany

fetch

ManyToMany<T> fetch(String fetch)
Sets the fetch attribute

Parameters:
fetch - the value for the attribute fetch
Returns:
the current instance of ManyToMany

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

ManyToMany<T> removeFetch()
Removes the fetch attribute

Returns:
the current instance of ManyToMany

access

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

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

access

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

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

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

ManyToMany<T> removeAccess()
Removes the access attribute

Returns:
the current instance of ManyToMany

mappedBy

ManyToMany<T> mappedBy(String mappedBy)
Sets the mapped-by attribute

Parameters:
mappedBy - the value for the attribute mapped-by
Returns:
the current instance of ManyToMany

getMappedBy

String getMappedBy()
Returns the mapped-by attribute

Returns:
the value defined for the attribute mapped-by

removeMappedBy

ManyToMany<T> removeMappedBy()
Removes the mapped-by attribute

Returns:
the current instance of ManyToMany


Copyright © 2013 JBoss, a division of Red Hat, Inc.. All Rights Reserved.