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

All Superinterfaces:

Child<T>, OrmSecondaryTableCommType<T,SecondaryTable<T>,PrimaryKeyJoinColumn<SecondaryTable<T>>,UniqueConstraint<SecondaryTable<T>>>
```
public interface SecondaryTable<T>
extends Child<T>, OrmSecondaryTableCommType<T,SecondaryTable<T>,PrimaryKeyJoinColumn<SecondaryTable<T>>,UniqueConstraint<SecondaryTable<T>>>
```
This interface defines the contract for the secondary-table xsd type

Author:

Ralf Battenfeld, Andrew Lee Rubinger

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`SecondaryTable<T>`	`catalog(String catalog)` Sets the `catalog` attribute
`Index<SecondaryTable<T>>`	`createIndex()` Creates a new `index` element
`PrimaryKeyJoinColumn<SecondaryTable<T>>`	`createPrimaryKeyJoinColumn()` Creates a new `primary-key-join-column` element
`UniqueConstraint<SecondaryTable<T>>`	`createUniqueConstraint()` Creates a new `unique-constraint` element
`List<Index<SecondaryTable<T>>>`	`getAllIndex()` Returns all `index` elements
`List<PrimaryKeyJoinColumn<SecondaryTable<T>>>`	`getAllPrimaryKeyJoinColumn()` Returns all `primary-key-join-column` elements
`List<UniqueConstraint<SecondaryTable<T>>>`	`getAllUniqueConstraint()` Returns all `unique-constraint` elements
`String`	`getCatalog()` Returns the `catalog` attribute
`String`	`getName()` Returns the `name` attribute
`Index<SecondaryTable<T>>`	`getOrCreateIndex()` If not already created, a new `index` element will be created and returned.
`ForeignKey<SecondaryTable<T>>`	`getOrCreatePrimaryKeyForeignKey()` If not already created, a new `primary-key-foreign-key` element with the given value will be created.
`PrimaryKeyJoinColumn<SecondaryTable<T>>`	`getOrCreatePrimaryKeyJoinColumn()` If not already created, a new `primary-key-join-column` element will be created and returned.
`UniqueConstraint<SecondaryTable<T>>`	`getOrCreateUniqueConstraint()` If not already created, a new `unique-constraint` element will be created and returned.
`String`	`getSchema()` Returns the `schema` attribute
`SecondaryTable<T>`	`name(String name)` Sets the `name` attribute
`SecondaryTable<T>`	`removeAllIndex()` Removes all `index` elements
`SecondaryTable<T>`	`removeAllPrimaryKeyJoinColumn()` Removes all `primary-key-join-column` elements
`SecondaryTable<T>`	`removeAllUniqueConstraint()` Removes all `unique-constraint` elements
`SecondaryTable<T>`	`removeCatalog()` Removes the `catalog` attribute
`SecondaryTable<T>`	`removeName()` Removes the `name` attribute
`SecondaryTable<T>`	`removePrimaryKeyForeignKey()` Removes the `primary-key-foreign-key` element
`SecondaryTable<T>`	`removeSchema()` Removes the `schema` attribute
`SecondaryTable<T>`	`schema(String schema)` Sets the `schema` attribute

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

- Method Detail
  - getOrCreatePrimaryKeyJoinColumn
```
PrimaryKeyJoinColumn<SecondaryTable<T>> getOrCreatePrimaryKeyJoinColumn()
```
    If not already created, a new primary-key-join-column element will be created and returned. Otherwise, the first existing primary-key-join-column element will be returned.
    
    Returns:
    
    the instance defined for the element primary-key-join-column
  - createPrimaryKeyJoinColumn
```
PrimaryKeyJoinColumn<SecondaryTable<T>> createPrimaryKeyJoinColumn()
```
    Creates a new primary-key-join-column element
    
    Returns:
    
    the new created instance of PrimaryKeyJoinColumn>
  - getAllPrimaryKeyJoinColumn
```
List<PrimaryKeyJoinColumn<SecondaryTable<T>>> getAllPrimaryKeyJoinColumn()
```
    Returns all primary-key-join-column elements
    
    Returns:
    
    list of primary-key-join-column
  - removeAllPrimaryKeyJoinColumn
```
SecondaryTable<T> removeAllPrimaryKeyJoinColumn()
```
    Removes all primary-key-join-column elements
    
    Returns:
    
    the current instance of PrimaryKeyJoinColumn>
  - getOrCreatePrimaryKeyForeignKey
```
ForeignKey<SecondaryTable<T>> getOrCreatePrimaryKeyForeignKey()
```
    If not already created, a new primary-key-foreign-key element with the given value will be created. Otherwise, the existing primary-key-foreign-key element will be returned.
    
    Returns:
    
    a new or existing instance of ForeignKey>
  - removePrimaryKeyForeignKey
```
SecondaryTable<T> removePrimaryKeyForeignKey()
```
    Removes the primary-key-foreign-key element
    
    Returns:
    
    the current instance of SecondaryTable
  - getOrCreateUniqueConstraint
```
UniqueConstraint<SecondaryTable<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<SecondaryTable<T>> createUniqueConstraint()
```
    Creates a new unique-constraint element
    
    Returns:
    
    the new created instance of UniqueConstraint>
  - getAllUniqueConstraint
```
List<UniqueConstraint<SecondaryTable<T>>> getAllUniqueConstraint()
```
    Returns all unique-constraint elements
    
    Returns:
    
    list of unique-constraint
  - removeAllUniqueConstraint
```
SecondaryTable<T> removeAllUniqueConstraint()
```
    Removes all unique-constraint elements
    
    Returns:
    
    the current instance of UniqueConstraint>
  - getOrCreateIndex
```
Index<SecondaryTable<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<SecondaryTable<T>> createIndex()
```
    Creates a new index element
    
    Returns:
    
    the new created instance of Index>
  - getAllIndex
```
List<Index<SecondaryTable<T>>> getAllIndex()
```
    Returns all index elements
    
    Returns:
    
    list of index
  - removeAllIndex
```
SecondaryTable<T> removeAllIndex()
```
    Removes all index elements
    
    Returns:
    
    the current instance of Index>
  - name
```
SecondaryTable<T> name(String name)
```
    Sets the name attribute
    
    Parameters:
    
    name - the value for the attribute name
    
    Returns:
    
    the current instance of SecondaryTable
  - getName
```
String getName()
```
    Returns the name attribute
    
    Returns:
    
    the value defined for the attribute name
  - removeName
```
SecondaryTable<T> removeName()
```
    Removes the name attribute
    
    Returns:
    
    the current instance of SecondaryTable
  - catalog
```
SecondaryTable<T> catalog(String catalog)
```
    Sets the catalog attribute
    
    Parameters:
    
    catalog - the value for the attribute catalog
    
    Returns:
    
    the current instance of SecondaryTable
  - getCatalog
```
String getCatalog()
```
    Returns the catalog attribute
    
    Returns:
    
    the value defined for the attribute catalog
  - removeCatalog
```
SecondaryTable<T> removeCatalog()
```
    Removes the catalog attribute
    
    Returns:
    
    the current instance of SecondaryTable
  - schema
```
SecondaryTable<T> schema(String schema)
```
    Sets the schema attribute
    
    Parameters:
    
    schema - the value for the attribute schema
    
    Returns:
    
    the current instance of SecondaryTable
  - getSchema
```
String getSchema()
```
    Returns the schema attribute
    
    Returns:
    
    the value defined for the attribute schema
  - removeSchema
```
SecondaryTable<T> removeSchema()
```
    Removes the schema attribute
    
    Returns:
    
    the current instance of SecondaryTable

Interface SecondaryTable<T>

Method Summary

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

Method Detail

getOrCreatePrimaryKeyJoinColumn

createPrimaryKeyJoinColumn

getAllPrimaryKeyJoinColumn

removeAllPrimaryKeyJoinColumn

getOrCreatePrimaryKeyForeignKey

removePrimaryKeyForeignKey

getOrCreateUniqueConstraint

createUniqueConstraint

getAllUniqueConstraint

removeAllUniqueConstraint

getOrCreateIndex

createIndex

getAllIndex

removeAllIndex

name

getName

removeName

catalog

getCatalog

removeCatalog

schema

getSchema

removeSchema