org.jboss.shrinkwrap.descriptor.api.orm10.Id Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of shrinkwrap-descriptors-api-javaee Show documentation
Show all versions of shrinkwrap-descriptors-api-javaee Show documentation
Client View of the ShrinkWrap Descriptors Project
The newest version!
package org.jboss.shrinkwrap.descriptor.api.orm10;
import java.util.ArrayList;
import java.util.List;
import org.jboss.shrinkwrap.descriptor.api.Child;
import org.jboss.shrinkwrap.descriptor.api.orm10.Column;
import org.jboss.shrinkwrap.descriptor.api.orm10.GeneratedValue;
import org.jboss.shrinkwrap.descriptor.api.orm10.TemporalType;
import org.jboss.shrinkwrap.descriptor.api.orm10.TableGenerator;
import org.jboss.shrinkwrap.descriptor.api.orm10.SequenceGenerator;
import org.jboss.shrinkwrap.descriptor.api.orm.*;
import org.jboss.shrinkwrap.descriptor.api.orm.OrmIdCommType;
import org.jboss.shrinkwrap.descriptor.api.orm10.Column;
import org.jboss.shrinkwrap.descriptor.api.orm10.GeneratedValue;
import org.jboss.shrinkwrap.descriptor.api.orm10.TableGenerator;
import org.jboss.shrinkwrap.descriptor.api.orm10.SequenceGenerator;/**
* This interface defines the contract for the id
xsd type
* @author Ralf Battenfeld
* @author Andrew Lee Rubinger
* @author George Gastaldi
*/
public interface Id extends Child,
OrmIdCommType,
Column>,
GeneratedValue>,
TableGenerator>,
SequenceGenerator>> {
// --------------------------------------------------------------------------------------------------------||
// ClassName: Id ElementName: orm:column ElementType : column
// MaxOccurs: - isGeneric: true isAttribute: false isEnum: false isDataType: false
// --------------------------------------------------------------------------------------------------------||
/**
* If not already created, a new column
element with the given value will be created.
* Otherwise, the existing column
element will be returned.
* @return a new or existing instance of Column>
*/
public Column> getOrCreateColumn();
/**
* Removes the column
element
* @return the current instance of Id
*/
public Id removeColumn();
// --------------------------------------------------------------------------------------------------------||
// ClassName: Id ElementName: orm:generated-value ElementType : generated-value
// MaxOccurs: - isGeneric: true isAttribute: false isEnum: false isDataType: false
// --------------------------------------------------------------------------------------------------------||
/**
* 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.
* @return a new or existing instance of GeneratedValue>
*/
public GeneratedValue> getOrCreateGeneratedValue();
/**
* Removes the generated-value
element
* @return the current instance of Id
*/
public Id removeGeneratedValue();
// --------------------------------------------------------------------------------------------------------||
// ClassName: Id ElementName: orm:temporal-type ElementType : temporal
// MaxOccurs: - isGeneric: true isAttribute: false isEnum: true isDataType: false
// --------------------------------------------------------------------------------------------------------||
/**
* Sets the temporal
element
* @param temporal the value for the element temporal
* @return the current instance of Id
*/
public Id temporal(TemporalType temporal);
/**
* Sets the temporal
element
* @param temporal the value for the element temporal
* @return the current instance of Id
*/
public Id temporal(String temporal);
/**
* Returns the temporal
element
* @return the value found for the element temporal
*/
public TemporalType getTemporal();
/**
* Returns the temporal
element
* @return the value found for the element temporal
*/
public String getTemporalAsString();
/**
* Removes the temporal
attribute
* @return the current instance of Id
*/
public Id removeTemporal();
// --------------------------------------------------------------------------------------------------------||
// ClassName: Id ElementName: orm:table-generator ElementType : table-generator
// MaxOccurs: - isGeneric: true isAttribute: false isEnum: false isDataType: false
// --------------------------------------------------------------------------------------------------------||
/**
* 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.
* @return a new or existing instance of TableGenerator>
*/
public TableGenerator> getOrCreateTableGenerator();
/**
* Removes the table-generator
element
* @return the current instance of Id
*/
public Id removeTableGenerator();
// --------------------------------------------------------------------------------------------------------||
// ClassName: Id ElementName: orm:sequence-generator ElementType : sequence-generator
// MaxOccurs: - isGeneric: true isAttribute: false isEnum: false isDataType: false
// --------------------------------------------------------------------------------------------------------||
/**
* 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.
* @return a new or existing instance of SequenceGenerator>
*/
public SequenceGenerator> getOrCreateSequenceGenerator();
/**
* Removes the sequence-generator
element
* @return the current instance of Id
*/
public Id removeSequenceGenerator();
// --------------------------------------------------------------------------------------------------------||
// ClassName: Id ElementName: xsd:string ElementType : name
// MaxOccurs: - isGeneric: true isAttribute: true isEnum: false isDataType: true
// --------------------------------------------------------------------------------------------------------||
/**
* Sets the name
attribute
* @param name the value for the attribute name
* @return the current instance of Id
*/
public Id name(String name);
/**
* Returns the name
attribute
* @return the value defined for the attribute name
*/
public String getName();
/**
* Removes the name
attribute
* @return the current instance of Id
*/
public Id removeName();
}