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

All Superinterfaces:

Child<T>, OrmIdCommType<T,Id<T>,Column<Id<T>>,GeneratedValue<Id<T>>,TableGenerator<Id<T>>,SequenceGenerator<Id<T>>>
```
public interface Id<T>
extends Child<T>, OrmIdCommType<T,Id<T>,Column<Id<T>>,GeneratedValue<Id<T>>,TableGenerator<Id<T>>,SequenceGenerator<Id<T>>>
```
This interface defines the contract for the id xsd type

Author:

Ralf Battenfeld, Andrew Lee Rubinger, George Gastaldi

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`Id<T>`	`access(AccessType access)` Sets the `access` attribute
`Id<T>`	`access(String access)` Sets the `access` attribute
`AccessType`	`getAccess()` Returns the `access` attribute
`String`	`getAccessAsString()` Returns the `access` attribute
`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>`	`removeAccess()` Removes the `access` 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
  - access
```
Id<T> access(AccessType access)
```
    Sets the access attribute
    
    Parameters:
    
    access - the value for the attribute access
    
    Returns:
    
    the current instance of Id
  - access
```
Id<T> access(String access)
```
    Sets the access attribute
    
    Parameters:
    
    access - the value for the attribute access
    
    Returns:
    
    the current instance of Id
  - getAccess
```
AccessType getAccess()
```
    Returns the access attribute
    
    Returns:
    
    the value defined for the attribute access
  - getAccessAsString
```
String getAccessAsString()
```
    Returns the access attribute
    
    Returns:
    
    the value found for the element access
  - removeAccess
```
Id<T> removeAccess()
```
    Removes the access attribute
    
    Returns:
    
    the current instance of Id

Interface Id<T>

Method Summary

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

Method Detail

getOrCreateColumn

removeColumn

getOrCreateGeneratedValue

removeGeneratedValue

temporal

temporal

getTemporal

getTemporalAsString

removeTemporal

getOrCreateTableGenerator

removeTableGenerator

getOrCreateSequenceGenerator

removeSequenceGenerator

name

getName

removeName

access

access

getAccess

getAccessAsString

removeAccess