ShrinkWrap Descriptors Generated Java EE API 2.0.0-alpha-3

org.jboss.shrinkwrap.descriptor.api.orm10
Interface Id<T>

All Superinterfaces:
Child<T>

public interface Id<T>
extends Child<T>

This interface defines the contract for the id xsd type

Since:
Generation date :2012-05-09T23:45:03.702-07:00
Author:
Ralf Battenfeld, Andrew Lee Rubinger

Method Summary
 String getName()
          Returns the name attribute
 Column<Id<T>> getOrCreateColumn()
          If not already created, a new column element with the given value will be created.
 GeneratedValue<Id<T>> getOrCreateGeneratedValue()
          If not already created, a new generated-value element with the given value will be created.
 SequenceGenerator<Id<T>> getOrCreateSequenceGenerator()
          If not already created, a new sequence-generator element with the given value will be created.
 TableGenerator<Id<T>> getOrCreateTableGenerator()
          If not already created, a new table-generator element with the given value will be created.
 TemporalType getTemporal()
          Returns the temporal element
 String getTemporalAsString()
          Returns the temporal element
 Id<T> name(String name)
          Sets the name attribute
 Id<T> removeColumn()
          Removes the column element
 Id<T> removeGeneratedValue()
          Removes the generated-value element
 Id<T> removeName()
          Removes the name attribute
 Id<T> removeSequenceGenerator()
          Removes the sequence-generator element
 Id<T> removeTableGenerator()
          Removes the table-generator element
 Id<T> removeTemporal()
          Removes the temporal attribute
 Id<T> temporal(String temporal)
          Sets the temporal element
 Id<T> temporal(TemporalType temporal)
          Sets the temporal element
 
Methods inherited from interface org.jboss.shrinkwrap.descriptor.api.Child
up
 

Method Detail

getOrCreateColumn

Column<Id<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

Id<T> removeColumn()
Removes the column element

Returns:
the current instance of Id

getOrCreateGeneratedValue

GeneratedValue<Id<T>> getOrCreateGeneratedValue()
If not already created, a new generated-value element with the given value will be created. Otherwise, the existing generated-value element will be returned.

Returns:
a new or existing instance of GeneratedValue>

removeGeneratedValue

Id<T> removeGeneratedValue()
Removes the generated-value element

Returns:
the current instance of Id

temporal

Id<T> temporal(TemporalType temporal)
Sets the temporal element

Parameters:
temporal - the value for the element temporal
Returns:
the current instance of Id

temporal

Id<T> temporal(String temporal)
Sets the temporal element

Parameters:
temporal - the value for the element temporal
Returns:
the current instance of Id

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

Id<T> removeTemporal()
Removes the temporal attribute

Returns:
the current instance of Id

getOrCreateTableGenerator

TableGenerator<Id<T>> getOrCreateTableGenerator()
If not already created, a new table-generator element with the given value will be created. Otherwise, the existing table-generator element will be returned.

Returns:
a new or existing instance of TableGenerator>

removeTableGenerator

Id<T> removeTableGenerator()
Removes the table-generator element

Returns:
the current instance of Id

getOrCreateSequenceGenerator

SequenceGenerator<Id<T>> getOrCreateSequenceGenerator()
If not already created, a new sequence-generator element with the given value will be created. Otherwise, the existing sequence-generator element will be returned.

Returns:
a new or existing instance of SequenceGenerator>

removeSequenceGenerator

Id<T> removeSequenceGenerator()
Removes the sequence-generator element

Returns:
the current instance of Id

name

Id<T> name(String name)
Sets the name attribute

Parameters:
name - the value for the attribute name
Returns:
the current instance of Id

getName

String getName()
Returns the name attribute

Returns:
the value defined for the attribute name

removeName

Id<T> removeName()
Removes the name attribute

Returns:
the current instance of Id

ShrinkWrap Descriptors Generated Java EE API 2.0.0-alpha-3

Copyright © 2012 JBoss by Red Hat. All Rights Reserved.