org.jboss.shrinkwrap.descriptor.api.orm21

Interface ForeignKey<T>

All Superinterfaces:

Child<T>, OrmForeignKeyCommType<T,ForeignKey<T>>

public interface ForeignKey<T>
extends Child<T>, OrmForeignKeyCommType<T,ForeignKey<T>>

This interface defines the contract for the foreign-key xsd type

Author:

Ralf Battenfeld, Andrew Lee Rubinger

Method Summary

Modifier and Type	Method and Description
ForeignKey<T>	constraintMode(ConstraintMode constraintMode) Sets the constraint-mode attribute
ForeignKey<T>	constraintMode(String constraintMode) Sets the constraint-mode attribute
ForeignKey<T>	description(String description) Sets the description element
ForeignKey<T>	foreignKeyDefinition(String foreignKeyDefinition) Sets the foreign-key-definition attribute
ConstraintMode	getConstraintMode() Returns the constraint-mode attribute
String	getConstraintModeAsString() Returns the constraint-mode attribute
String	getDescription() Returns the description element
String	getForeignKeyDefinition() Returns the foreign-key-definition attribute
String	getName() Returns the name attribute
ForeignKey<T>	name(String name) Sets the name attribute
ForeignKey<T>	removeConstraintMode() Removes the constraint-mode attribute
ForeignKey<T>	removeDescription() Removes the description element
ForeignKey<T>	removeForeignKeyDefinition() Removes the foreign-key-definition attribute
ForeignKey<T>	removeName() Removes the name attribute

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

up

Method Detail

description

ForeignKey<T> description(String description)

Sets the description element

Parameters:

description - the value for the element description

Returns:

the current instance of ForeignKey

getDescription

String getDescription()

Returns the description element

Returns:

the node defined for the element description

removeDescription

ForeignKey<T> removeDescription()

Removes the description element

Returns:

the current instance of ForeignKey

name

ForeignKey<T> name(String name)

Sets the name attribute

Parameters:

name - the value for the attribute name

Returns:

the current instance of ForeignKey

getName

String getName()

Returns the name attribute

Returns:

the value defined for the attribute name

removeName

ForeignKey<T> removeName()

Removes the name attribute

Returns:

the current instance of ForeignKey

constraintMode

ForeignKey<T> constraintMode(ConstraintMode constraintMode)

Sets the constraint-mode attribute

Parameters:

constraintMode - the value for the attribute constraint-mode

Returns:

the current instance of ForeignKey

constraintMode

ForeignKey<T> constraintMode(String constraintMode)

Sets the constraint-mode attribute

Parameters:

constraintMode - the value for the attribute constraint-mode

Returns:

the current instance of ForeignKey

getConstraintMode

ConstraintMode getConstraintMode()

Returns the constraint-mode attribute

Returns:

the value defined for the attribute constraint-mode

getConstraintModeAsString

String getConstraintModeAsString()

Returns the constraint-mode attribute

Returns:

the value found for the element constraint-mode

removeConstraintMode

ForeignKey<T> removeConstraintMode()

Removes the constraint-mode attribute

Returns:

the current instance of ForeignKey

foreignKeyDefinition

ForeignKey<T> foreignKeyDefinition(String foreignKeyDefinition)

Sets the foreign-key-definition attribute

Parameters:

foreignKeyDefinition - the value for the attribute foreign-key-definition

Returns:

the current instance of ForeignKey

getForeignKeyDefinition

String getForeignKeyDefinition()

Returns the foreign-key-definition attribute

Returns:

the value defined for the attribute foreign-key-definition

removeForeignKeyDefinition

ForeignKey<T> removeForeignKeyDefinition()

Removes the foreign-key-definition attribute

Returns:

the current instance of ForeignKey