org.jboss.shrinkwrap.descriptor.api.orm10

Interface SecondaryTable<T>

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, George Gastaldi

Method Summary

Modifier and Type	Method and Description
SecondaryTable<T>	catalog(String catalog) Sets the catalog attribute
PrimaryKeyJoinColumn<SecondaryTable<T>>	createPrimaryKeyJoinColumn() Creates a new primary-key-join-column element
UniqueConstraint<SecondaryTable<T>>	createUniqueConstraint() Creates a new unique-constraint element
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
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>	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>	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>

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>

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