JoinTable (ShrinkWrap Descriptors Aggregator 2.0.0-alpha-9 API)

All Superinterfaces:

Child<T>, OrmJoinTableCommType<T,JoinTable<T>,JoinColumn<JoinTable<T>>,JoinColumn<JoinTable<T>>,UniqueConstraint<JoinTable<T>>>
```
public interface JoinTable<T>
extends Child<T>, OrmJoinTableCommType<T,JoinTable<T>,JoinColumn<JoinTable<T>>,JoinColumn<JoinTable<T>>,UniqueConstraint<JoinTable<T>>>
```
This interface defines the contract for the join-table xsd type

Author:

Ralf Battenfeld, Andrew Lee Rubinger

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`JoinTable<T>`	`catalog(String catalog)` Sets the `catalog` attribute
`Index<JoinTable<T>>`	`createIndex()` Creates a new `index` element
`JoinColumn<JoinTable<T>>`	`createInverseJoinColumn()` Creates a new `inverse-join-column` element
`JoinColumn<JoinTable<T>>`	`createJoinColumn()` Creates a new `join-column` element
`UniqueConstraint<JoinTable<T>>`	`createUniqueConstraint()` Creates a new `unique-constraint` element
`List<Index<JoinTable<T>>>`	`getAllIndex()` Returns all `index` elements
`List<JoinColumn<JoinTable<T>>>`	`getAllInverseJoinColumn()` Returns all `inverse-join-column` elements
`List<JoinColumn<JoinTable<T>>>`	`getAllJoinColumn()` Returns all `join-column` elements
`List<UniqueConstraint<JoinTable<T>>>`	`getAllUniqueConstraint()` Returns all `unique-constraint` elements
`String`	`getCatalog()` Returns the `catalog` attribute
`String`	`getName()` Returns the `name` attribute
`ForeignKey<JoinTable<T>>`	`getOrCreateForeignKey()` If not already created, a new `foreign-key` element with the given value will be created.
`Index<JoinTable<T>>`	`getOrCreateIndex()` If not already created, a new `index` element will be created and returned.
`ForeignKey<JoinTable<T>>`	`getOrCreateInverseForeignKey()` If not already created, a new `inverse-foreign-key` element with the given value will be created.
`JoinColumn<JoinTable<T>>`	`getOrCreateInverseJoinColumn()` If not already created, a new `inverse-join-column` element will be created and returned.
`JoinColumn<JoinTable<T>>`	`getOrCreateJoinColumn()` If not already created, a new `join-column` element will be created and returned.
`UniqueConstraint<JoinTable<T>>`	`getOrCreateUniqueConstraint()` If not already created, a new `unique-constraint` element will be created and returned.
`String`	`getSchema()` Returns the `schema` attribute
`JoinTable<T>`	`name(String name)` Sets the `name` attribute
`JoinTable<T>`	`removeAllIndex()` Removes all `index` elements
`JoinTable<T>`	`removeAllInverseJoinColumn()` Removes all `inverse-join-column` elements
`JoinTable<T>`	`removeAllJoinColumn()` Removes all `join-column` elements
`JoinTable<T>`	`removeAllUniqueConstraint()` Removes all `unique-constraint` elements
`JoinTable<T>`	`removeCatalog()` Removes the `catalog` attribute
`JoinTable<T>`	`removeForeignKey()` Removes the `foreign-key` element
`JoinTable<T>`	`removeInverseForeignKey()` Removes the `inverse-foreign-key` element
`JoinTable<T>`	`removeName()` Removes the `name` attribute
`JoinTable<T>`	`removeSchema()` Removes the `schema` attribute
`JoinTable<T>`	`schema(String schema)` Sets the `schema` attribute

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

- Method Detail
  - getOrCreateJoinColumn
```
JoinColumn<JoinTable<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<JoinTable<T>> createJoinColumn()
```
    Creates a new join-column element
    
    Returns:
    
    the new created instance of JoinColumn>
  - getAllJoinColumn
```
List<JoinColumn<JoinTable<T>>> getAllJoinColumn()
```
    Returns all join-column elements
    
    Returns:
    
    list of join-column
  - removeAllJoinColumn
```
JoinTable<T> removeAllJoinColumn()
```
    Removes all join-column elements
    
    Returns:
    
    the current instance of JoinColumn>
  - getOrCreateForeignKey
```
ForeignKey<JoinTable<T>> getOrCreateForeignKey()
```
    If not already created, a new foreign-key element with the given value will be created. Otherwise, the existing foreign-key element will be returned.
    
    Returns:
    
    a new or existing instance of ForeignKey>
  - removeForeignKey
```
JoinTable<T> removeForeignKey()
```
    Removes the foreign-key element
    
    Returns:
    
    the current instance of JoinTable
  - getOrCreateInverseJoinColumn
```
JoinColumn<JoinTable<T>> getOrCreateInverseJoinColumn()
```
    If not already created, a new inverse-join-column element will be created and returned. Otherwise, the first existing inverse-join-column element will be returned.
    
    Returns:
    
    the instance defined for the element inverse-join-column
  - createInverseJoinColumn
```
JoinColumn<JoinTable<T>> createInverseJoinColumn()
```
    Creates a new inverse-join-column element
    
    Returns:
    
    the new created instance of JoinColumn>
  - getAllInverseJoinColumn
```
List<JoinColumn<JoinTable<T>>> getAllInverseJoinColumn()
```
    Returns all inverse-join-column elements
    
    Returns:
    
    list of inverse-join-column
  - removeAllInverseJoinColumn
```
JoinTable<T> removeAllInverseJoinColumn()
```
    Removes all inverse-join-column elements
    
    Returns:
    
    the current instance of JoinColumn>
  - getOrCreateInverseForeignKey
```
ForeignKey<JoinTable<T>> getOrCreateInverseForeignKey()
```
    If not already created, a new inverse-foreign-key element with the given value will be created. Otherwise, the existing inverse-foreign-key element will be returned.
    
    Returns:
    
    a new or existing instance of ForeignKey>
  - removeInverseForeignKey
```
JoinTable<T> removeInverseForeignKey()
```
    Removes the inverse-foreign-key element
    
    Returns:
    
    the current instance of JoinTable
  - getOrCreateUniqueConstraint
```
UniqueConstraint<JoinTable<T>> getOrCreateUniqueConstraint()
```
    If not already created, a new unique-constraint element will be created and returned. Otherwise, the first existing unique-constraint element will be returned.
    
    Returns:
    
    the instance defined for the element unique-constraint
  - createUniqueConstraint
```
UniqueConstraint<JoinTable<T>> createUniqueConstraint()
```
    Creates a new unique-constraint element
    
    Returns:
    
    the new created instance of UniqueConstraint>
  - getAllUniqueConstraint
```
List<UniqueConstraint<JoinTable<T>>> getAllUniqueConstraint()
```
    Returns all unique-constraint elements
    
    Returns:
    
    list of unique-constraint
  - removeAllUniqueConstraint
```
JoinTable<T> removeAllUniqueConstraint()
```
    Removes all unique-constraint elements
    
    Returns:
    
    the current instance of UniqueConstraint>
  - getOrCreateIndex
```
Index<JoinTable<T>> getOrCreateIndex()
```
    If not already created, a new index element will be created and returned. Otherwise, the first existing index element will be returned.
    
    Returns:
    
    the instance defined for the element index
  - createIndex
```
Index<JoinTable<T>> createIndex()
```
    Creates a new index element
    
    Returns:
    
    the new created instance of Index>
  - getAllIndex
```
List<Index<JoinTable<T>>> getAllIndex()
```
    Returns all index elements
    
    Returns:
    
    list of index
  - removeAllIndex
```
JoinTable<T> removeAllIndex()
```
    Removes all index elements
    
    Returns:
    
    the current instance of Index>
  - name
```
JoinTable<T> name(String name)
```
    Sets the name attribute
    
    Parameters:
    
    name - the value for the attribute name
    
    Returns:
    
    the current instance of JoinTable
  - getName
```
String getName()
```
    Returns the name attribute
    
    Returns:
    
    the value defined for the attribute name
  - removeName
```
JoinTable<T> removeName()
```
    Removes the name attribute
    
    Returns:
    
    the current instance of JoinTable
  - catalog
```
JoinTable<T> catalog(String catalog)
```
    Sets the catalog attribute
    
    Parameters:
    
    catalog - the value for the attribute catalog
    
    Returns:
    
    the current instance of JoinTable
  - getCatalog
```
String getCatalog()
```
    Returns the catalog attribute
    
    Returns:
    
    the value defined for the attribute catalog
  - removeCatalog
```
JoinTable<T> removeCatalog()
```
    Removes the catalog attribute
    
    Returns:
    
    the current instance of JoinTable
  - schema
```
JoinTable<T> schema(String schema)
```
    Sets the schema attribute
    
    Parameters:
    
    schema - the value for the attribute schema
    
    Returns:
    
    the current instance of JoinTable
  - getSchema
```
String getSchema()
```
    Returns the schema attribute
    
    Returns:
    
    the value defined for the attribute schema
  - removeSchema
```
JoinTable<T> removeSchema()
```
    Removes the schema attribute
    
    Returns:
    
    the current instance of JoinTable

Interface JoinTable<T>

Method Summary

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

Method Detail

getOrCreateJoinColumn

createJoinColumn

getAllJoinColumn

removeAllJoinColumn

getOrCreateForeignKey

removeForeignKey

getOrCreateInverseJoinColumn

createInverseJoinColumn

getAllInverseJoinColumn

removeAllInverseJoinColumn

getOrCreateInverseForeignKey

removeInverseForeignKey

getOrCreateUniqueConstraint

createUniqueConstraint

getAllUniqueConstraint

removeAllUniqueConstraint

getOrCreateIndex

createIndex

getAllIndex

removeAllIndex

name

getName

removeName

catalog

getCatalog

removeCatalog

schema

getSchema

removeSchema