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

All Superinterfaces:

Child<T>

public interface ElementCollection<T>
extends Child<T>

This interface defines the contract for the element-collection xsd type

Since:

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

Author:

Ralf Battenfeld, Andrew Lee Rubinger

Method Summary

ElementCollection<T>	access(AccessType access) Sets the access attribute
ElementCollection<T>	access(String access) Sets the access attribute
AssociationOverride<ElementCollection<T>>	createAssociationOverride() Creates a new association-override element
AttributeOverride<ElementCollection<T>>	createAttributeOverride() Creates a new attribute-override element
AttributeOverride<ElementCollection<T>>	createMapKeyAttributeOverride() Creates a new map-key-attribute-override element
MapKeyJoinColumn<ElementCollection<T>>	createMapKeyJoinColumn() Creates a new map-key-join-column element
ElementCollection<T>	enumerated(EnumType enumerated) Sets the enumerated element
ElementCollection<T>	enumerated(String enumerated) Sets the enumerated element
ElementCollection<T>	fetch(FetchType fetch) Sets the fetch attribute
ElementCollection<T>	fetch(String fetch) Sets the fetch attribute
AccessType	getAccess() Returns the access attribute
String	getAccessAsString() Returns the access attribute
List<AssociationOverride<ElementCollection<T>>>	getAllAssociationOverride() Returns all association-override elements
List<AttributeOverride<ElementCollection<T>>>	getAllAttributeOverride() Returns all attribute-override elements
List<AttributeOverride<ElementCollection<T>>>	getAllMapKeyAttributeOverride() Returns all map-key-attribute-override elements
List<MapKeyJoinColumn<ElementCollection<T>>>	getAllMapKeyJoinColumn() Returns all map-key-join-column elements
EnumType	getEnumerated() Returns the enumerated element
String	getEnumeratedAsString() Returns the enumerated element
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	getName() Returns the name attribute
AssociationOverride<ElementCollection<T>>	getOrCreateAssociationOverride() If not already created, a new association-override element will be created and returned.
AttributeOverride<ElementCollection<T>>	getOrCreateAttributeOverride() If not already created, a new attribute-override element will be created and returned.
CollectionTable<ElementCollection<T>>	getOrCreateCollectionTable() If not already created, a new collection-table element with the given value will be created.
Column<ElementCollection<T>>	getOrCreateColumn() If not already created, a new column element with the given value will be created.
MapKey<ElementCollection<T>>	getOrCreateMapKey() If not already created, a new map-key element with the given value will be created.
AttributeOverride<ElementCollection<T>>	getOrCreateMapKeyAttributeOverride() If not already created, a new map-key-attribute-override element will be created and returned.
MapKeyClass<ElementCollection<T>>	getOrCreateMapKeyClass() If not already created, a new map-key-class element with the given value will be created.
MapKeyColumn<ElementCollection<T>>	getOrCreateMapKeyColumn() If not already created, a new map-key-column element with the given value will be created.
MapKeyJoinColumn<ElementCollection<T>>	getOrCreateMapKeyJoinColumn() If not already created, a new map-key-join-column element will be created and returned.
OrderColumn<ElementCollection<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	getTargetClass() Returns the target-class attribute
TemporalType	getTemporal() Returns the temporal element
String	getTemporalAsString() Returns the temporal element
Boolean	isLob() Removes the lob element
ElementCollection<T>	lob() Sets the lob element
ElementCollection<T>	mapKeyEnumerated(EnumType mapKeyEnumerated) Sets the map-key-enumerated element
ElementCollection<T>	mapKeyEnumerated(String mapKeyEnumerated) Sets the map-key-enumerated element
ElementCollection<T>	mapKeyTemporal(String mapKeyTemporal) Sets the map-key-temporal element
ElementCollection<T>	mapKeyTemporal(TemporalType mapKeyTemporal) Sets the map-key-temporal element
ElementCollection<T>	name(String name) Sets the name attribute
ElementCollection<T>	orderBy(String orderBy) Sets the order-by element
ElementCollection<T>	removeAccess() Removes the access attribute
ElementCollection<T>	removeAllAssociationOverride() Removes all association-override elements
ElementCollection<T>	removeAllAttributeOverride() Removes all attribute-override elements
ElementCollection<T>	removeAllMapKeyAttributeOverride() Removes all map-key-attribute-override elements
ElementCollection<T>	removeAllMapKeyJoinColumn() Removes all map-key-join-column elements
ElementCollection<T>	removeCollectionTable() Removes the collection-table element
ElementCollection<T>	removeColumn() Removes the column element
ElementCollection<T>	removeEnumerated() Removes the enumerated attribute
ElementCollection<T>	removeFetch() Removes the fetch attribute
ElementCollection<T>	removeLob() Removes the lob element
ElementCollection<T>	removeMapKey() Removes the map-key element
ElementCollection<T>	removeMapKeyClass() Removes the map-key-class element
ElementCollection<T>	removeMapKeyColumn() Removes the map-key-column element
ElementCollection<T>	removeMapKeyEnumerated() Removes the map-key-enumerated attribute
ElementCollection<T>	removeMapKeyTemporal() Removes the map-key-temporal attribute
ElementCollection<T>	removeName() Removes the name attribute
ElementCollection<T>	removeOrderBy() Removes the order-by element
ElementCollection<T>	removeOrderColumn() Removes the order-column element
ElementCollection<T>	removeTargetClass() Removes the target-class attribute
ElementCollection<T>	removeTemporal() Removes the temporal attribute
ElementCollection<T>	targetClass(String targetClass) Sets the target-class attribute
ElementCollection<T>	temporal(String temporal) Sets the temporal element
ElementCollection<T>	temporal(TemporalType temporal) Sets the temporal element

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

up

Method Detail

orderBy

ElementCollection<T> orderBy(String orderBy)

Sets the order-by element

Parameters:

orderBy - the value for the element order-by

Returns:

the current instance of ElementCollection

getOrderBy

String getOrderBy()

Returns the order-by element

Returns:

the node defined for the element order-by

removeOrderBy

ElementCollection<T> removeOrderBy()

Removes the order-by element

Returns:

the current instance of ElementCollection

getOrCreateOrderColumn

OrderColumn<ElementCollection<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

ElementCollection<T> removeOrderColumn()

Removes the order-column element

Returns:

the current instance of ElementCollection

getOrCreateMapKey

MapKey<ElementCollection<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

ElementCollection<T> removeMapKey()

Removes the map-key element

Returns:

the current instance of ElementCollection

getOrCreateMapKeyClass

MapKeyClass<ElementCollection<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

ElementCollection<T> removeMapKeyClass()

Removes the map-key-class element

Returns:

the current instance of ElementCollection

mapKeyTemporal

ElementCollection<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 ElementCollection

mapKeyTemporal

ElementCollection<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 ElementCollection

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

ElementCollection<T> removeMapKeyTemporal()

Removes the map-key-temporal attribute

Returns:

the current instance of ElementCollection

mapKeyEnumerated

ElementCollection<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 ElementCollection

mapKeyEnumerated

ElementCollection<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 ElementCollection

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

ElementCollection<T> removeMapKeyEnumerated()

Removes the map-key-enumerated attribute

Returns:

the current instance of ElementCollection

getOrCreateMapKeyAttributeOverride

AttributeOverride<ElementCollection<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<ElementCollection<T>> createMapKeyAttributeOverride()

Creates a new map-key-attribute-override element

Returns:

the new created instance of AttributeOverride>

getAllMapKeyAttributeOverride

List<AttributeOverride<ElementCollection<T>>> getAllMapKeyAttributeOverride()

Returns all map-key-attribute-override elements

Returns:

list of map-key-attribute-override

removeAllMapKeyAttributeOverride

ElementCollection<T> removeAllMapKeyAttributeOverride()

Removes all map-key-attribute-override elements

Returns:

the current instance of AttributeOverride>

getOrCreateMapKeyColumn

MapKeyColumn<ElementCollection<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

ElementCollection<T> removeMapKeyColumn()

Removes the map-key-column element

Returns:

the current instance of ElementCollection

getOrCreateMapKeyJoinColumn

MapKeyJoinColumn<ElementCollection<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<ElementCollection<T>> createMapKeyJoinColumn()

Creates a new map-key-join-column element

Returns:

the new created instance of MapKeyJoinColumn>

getAllMapKeyJoinColumn

List<MapKeyJoinColumn<ElementCollection<T>>> getAllMapKeyJoinColumn()

Returns all map-key-join-column elements

Returns:

list of map-key-join-column

removeAllMapKeyJoinColumn

ElementCollection<T> removeAllMapKeyJoinColumn()

Removes all map-key-join-column elements

Returns:

the current instance of MapKeyJoinColumn>

getOrCreateColumn

Column<ElementCollection<T>> getOrCreateColumn()

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

Returns:

a new or existing instance of Column>

removeColumn

ElementCollection<T> removeColumn()

Removes the column element

Returns:

the current instance of ElementCollection

temporal

ElementCollection<T> temporal(TemporalType temporal)

Sets the temporal element

Parameters:

temporal - the value for the element temporal

Returns:

the current instance of ElementCollection

temporal

ElementCollection<T> temporal(String temporal)

Sets the temporal element

Parameters:

temporal - the value for the element temporal

Returns:

the current instance of ElementCollection

getTemporal

TemporalType getTemporal()

Returns the temporal element

Returns:

the value found for the element temporal

getTemporalAsString

String getTemporalAsString()

Returns the temporal element

Returns:

the value found for the element temporal

removeTemporal

ElementCollection<T> removeTemporal()

Removes the temporal attribute

Returns:

the current instance of ElementCollection

enumerated

ElementCollection<T> enumerated(EnumType enumerated)

Sets the enumerated element

Parameters:

enumerated - the value for the element enumerated

Returns:

the current instance of ElementCollection

enumerated

ElementCollection<T> enumerated(String enumerated)

Sets the enumerated element

Parameters:

enumerated - the value for the element enumerated

Returns:

the current instance of ElementCollection

getEnumerated

EnumType getEnumerated()

Returns the enumerated element

Returns:

the value found for the element enumerated

getEnumeratedAsString

String getEnumeratedAsString()

Returns the enumerated element

Returns:

the value found for the element enumerated

removeEnumerated

ElementCollection<T> removeEnumerated()

Removes the enumerated attribute

Returns:

the current instance of ElementCollection

lob

ElementCollection<T> lob()

Sets the lob element

Returns:

the current instance of ElementCollection

isLob

Boolean isLob()

Removes the lob element

Returns:

the current instance of ElementCollection

removeLob

ElementCollection<T> removeLob()

Removes the lob element

Returns:

the current instance of ElementCollection

getOrCreateAttributeOverride

AttributeOverride<ElementCollection<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<ElementCollection<T>> createAttributeOverride()

Creates a new attribute-override element

Returns:

the new created instance of AttributeOverride>

getAllAttributeOverride

List<AttributeOverride<ElementCollection<T>>> getAllAttributeOverride()

Returns all attribute-override elements

Returns:

list of attribute-override

removeAllAttributeOverride

ElementCollection<T> removeAllAttributeOverride()

Removes all attribute-override elements

Returns:

the current instance of AttributeOverride>

getOrCreateAssociationOverride

AssociationOverride<ElementCollection<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<ElementCollection<T>> createAssociationOverride()

Creates a new association-override element

Returns:

the new created instance of AssociationOverride>

getAllAssociationOverride

List<AssociationOverride<ElementCollection<T>>> getAllAssociationOverride()

Returns all association-override elements

Returns:

list of association-override

removeAllAssociationOverride

ElementCollection<T> removeAllAssociationOverride()

Removes all association-override elements

Returns:

the current instance of AssociationOverride>

getOrCreateCollectionTable

CollectionTable<ElementCollection<T>> getOrCreateCollectionTable()

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

Returns:

a new or existing instance of CollectionTable>

removeCollectionTable

ElementCollection<T> removeCollectionTable()

Removes the collection-table element

Returns:

the current instance of ElementCollection

name

ElementCollection<T> name(String name)

Sets the name attribute

Parameters:

name - the value for the attribute name

Returns:

the current instance of ElementCollection

getName

String getName()

Returns the name attribute

Returns:

the value defined for the attribute name

removeName

ElementCollection<T> removeName()

Removes the name attribute

Returns:

the current instance of ElementCollection

targetClass

ElementCollection<T> targetClass(String targetClass)

Sets the target-class attribute

Parameters:

targetClass - the value for the attribute target-class

Returns:

the current instance of ElementCollection

getTargetClass

String getTargetClass()

Returns the target-class attribute

Returns:

the value defined for the attribute target-class

removeTargetClass

ElementCollection<T> removeTargetClass()

Removes the target-class attribute

Returns:

the current instance of ElementCollection

fetch

ElementCollection<T> fetch(FetchType fetch)

Sets the fetch attribute

Parameters:

fetch - the value for the attribute fetch

Returns:

the current instance of ElementCollection

fetch

ElementCollection<T> fetch(String fetch)

Sets the fetch attribute

Parameters:

fetch - the value for the attribute fetch

Returns:

the current instance of ElementCollection

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

ElementCollection<T> removeFetch()

Removes the fetch attribute

Returns:

the current instance of ElementCollection

access

ElementCollection<T> access(AccessType access)

Sets the access attribute

Parameters:

access - the value for the attribute access

Returns:

the current instance of ElementCollection

access

ElementCollection<T> access(String access)

Sets the access attribute

Parameters:

access - the value for the attribute access

Returns:

the current instance of ElementCollection

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

ElementCollection<T> removeAccess()

Removes the access attribute

Returns:

the current instance of ElementCollection