org.jboss.shrinkwrap.descriptor.api.orm21.TableGenerator Maven / Gradle / Ivy
package org.jboss.shrinkwrap.descriptor.api.orm21;
import java.util.ArrayList;
import java.util.List;
import org.jboss.shrinkwrap.descriptor.api.Child;
import org.jboss.shrinkwrap.descriptor.api.orm21.UniqueConstraint;
import org.jboss.shrinkwrap.descriptor.api.orm21.Index;
import org.jboss.shrinkwrap.descriptor.api.orm.*;
import org.jboss.shrinkwrap.descriptor.api.orm.OrmTableGeneratorCommType;
import org.jboss.shrinkwrap.descriptor.api.orm21.UniqueConstraint;/**
* This interface defines the contract for the table-generator xsd type
* @author Ralf Battenfeld
* @author Andrew Lee Rubinger
*/
public interface TableGenerator extends Child,
OrmTableGeneratorCommType,
UniqueConstraint>> {
// --------------------------------------------------------------------------------------------------------||
// ClassName: TableGenerator ElementName: xsd:string ElementType : description
// MaxOccurs: - isGeneric: true isAttribute: false isEnum: false isDataType: true
// --------------------------------------------------------------------------------------------------------||
/**
* Sets the description element
* @param description the value for the element description
* @return the current instance of TableGenerator
*/
public TableGenerator description(String description);
/**
* Returns the description element
* @return the node defined for the element description
*/
public String getDescription();
/**
* Removes the description element
* @return the current instance of TableGenerator
*/
public TableGenerator removeDescription();
// --------------------------------------------------------------------------------------------------------||
// ClassName: TableGenerator ElementName: orm:unique-constraint ElementType : unique-constraint
// MaxOccurs: -unbounded isGeneric: true isAttribute: false isEnum: false isDataType: false
// --------------------------------------------------------------------------------------------------------||
/**
* If not already created, a new unique-constraint element will be created and returned.
* Otherwise, the first existing unique-constraint element will be returned.
* @return the instance defined for the element unique-constraint
*/
public UniqueConstraint> getOrCreateUniqueConstraint();
/**
* Creates a new unique-constraint element
* @return the new created instance of UniqueConstraint>
*/
public UniqueConstraint> createUniqueConstraint();
/**
* Returns all unique-constraint elements
* @return list of unique-constraint
*/
public List>> getAllUniqueConstraint();
/**
* Removes all unique-constraint elements
* @return the current instance of UniqueConstraint>
*/
public TableGenerator removeAllUniqueConstraint();
// --------------------------------------------------------------------------------------------------------||
// ClassName: TableGenerator ElementName: orm:index ElementType : index
// MaxOccurs: -unbounded isGeneric: true isAttribute: false isEnum: false isDataType: false
// --------------------------------------------------------------------------------------------------------||
/**
* If not already created, a new index element will be created and returned.
* Otherwise, the first existing index element will be returned.
* @return the instance defined for the element index
*/
public Index> getOrCreateIndex();
/**
* Creates a new index element
* @return the new created instance of Index>
*/
public Index> createIndex();
/**
* Returns all index elements
* @return list of index
*/
public List>> getAllIndex();
/**
* Removes all index elements
* @return the current instance of Index>
*/
public TableGenerator removeAllIndex();
// --------------------------------------------------------------------------------------------------------||
// ClassName: TableGenerator 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 TableGenerator
*/
public TableGenerator 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 TableGenerator
*/
public TableGenerator removeName();
// --------------------------------------------------------------------------------------------------------||
// ClassName: TableGenerator ElementName: xsd:string ElementType : table
// MaxOccurs: - isGeneric: true isAttribute: true isEnum: false isDataType: true
// --------------------------------------------------------------------------------------------------------||
/**
* Sets the table attribute
* @param table the value for the attribute table
* @return the current instance of TableGenerator
*/
public TableGenerator table(String table);
/**
* Returns the table attribute
* @return the value defined for the attribute table
*/
public String getTable();
/**
* Removes the table attribute
* @return the current instance of TableGenerator
*/
public TableGenerator removeTable();
// --------------------------------------------------------------------------------------------------------||
// ClassName: TableGenerator ElementName: xsd:string ElementType : catalog
// MaxOccurs: - isGeneric: true isAttribute: true isEnum: false isDataType: true
// --------------------------------------------------------------------------------------------------------||
/**
* Sets the catalog attribute
* @param catalog the value for the attribute catalog
* @return the current instance of TableGenerator
*/
public TableGenerator catalog(String catalog);
/**
* Returns the catalog attribute
* @return the value defined for the attribute catalog
*/
public String getCatalog();
/**
* Removes the catalog attribute
* @return the current instance of TableGenerator
*/
public TableGenerator removeCatalog();
// --------------------------------------------------------------------------------------------------------||
// ClassName: TableGenerator ElementName: xsd:string ElementType : schema
// MaxOccurs: - isGeneric: true isAttribute: true isEnum: false isDataType: true
// --------------------------------------------------------------------------------------------------------||
/**
* Sets the schema attribute
* @param schema the value for the attribute schema
* @return the current instance of TableGenerator
*/
public TableGenerator schema(String schema);
/**
* Returns the schema attribute
* @return the value defined for the attribute schema
*/
public String getSchema();
/**
* Removes the schema attribute
* @return the current instance of TableGenerator
*/
public TableGenerator removeSchema();
// --------------------------------------------------------------------------------------------------------||
// ClassName: TableGenerator ElementName: xsd:string ElementType : pk-column-name
// MaxOccurs: - isGeneric: true isAttribute: true isEnum: false isDataType: true
// --------------------------------------------------------------------------------------------------------||
/**
* Sets the pk-column-name attribute
* @param pkColumnName the value for the attribute pk-column-name
* @return the current instance of TableGenerator
*/
public TableGenerator pkColumnName(String pkColumnName);
/**
* Returns the pk-column-name attribute
* @return the value defined for the attribute pk-column-name
*/
public String getPkColumnName();
/**
* Removes the pk-column-name attribute
* @return the current instance of TableGenerator
*/
public TableGenerator removePkColumnName();
// --------------------------------------------------------------------------------------------------------||
// ClassName: TableGenerator ElementName: xsd:string ElementType : value-column-name
// MaxOccurs: - isGeneric: true isAttribute: true isEnum: false isDataType: true
// --------------------------------------------------------------------------------------------------------||
/**
* Sets the value-column-name attribute
* @param valueColumnName the value for the attribute value-column-name
* @return the current instance of TableGenerator
*/
public TableGenerator valueColumnName(String valueColumnName);
/**
* Returns the value-column-name attribute
* @return the value defined for the attribute value-column-name
*/
public String getValueColumnName();
/**
* Removes the value-column-name attribute
* @return the current instance of TableGenerator
*/
public TableGenerator removeValueColumnName();
// --------------------------------------------------------------------------------------------------------||
// ClassName: TableGenerator ElementName: xsd:string ElementType : pk-column-value
// MaxOccurs: - isGeneric: true isAttribute: true isEnum: false isDataType: true
// --------------------------------------------------------------------------------------------------------||
/**
* Sets the pk-column-value attribute
* @param pkColumnValue the value for the attribute pk-column-value
* @return the current instance of TableGenerator
*/
public TableGenerator pkColumnValue(String pkColumnValue);
/**
* Returns the pk-column-value attribute
* @return the value defined for the attribute pk-column-value
*/
public String getPkColumnValue();
/**
* Removes the pk-column-value attribute
* @return the current instance of TableGenerator
*/
public TableGenerator removePkColumnValue();
// --------------------------------------------------------------------------------------------------------||
// ClassName: TableGenerator ElementName: xsd:int ElementType : initial-value
// MaxOccurs: - isGeneric: true isAttribute: true isEnum: false isDataType: true
// --------------------------------------------------------------------------------------------------------||
/**
* Sets the initial-value attribute
* @param initialValue the value for the attribute initial-value
* @return the current instance of TableGenerator
*/
public TableGenerator initialValue(Integer initialValue);
/**
* Returns the initial-value attribute
* @return the value defined for the attribute initial-value
*/
public Integer getInitialValue();
/**
* Removes the initial-value attribute
* @return the current instance of TableGenerator
*/
public TableGenerator removeInitialValue();
// --------------------------------------------------------------------------------------------------------||
// ClassName: TableGenerator ElementName: xsd:int ElementType : allocation-size
// MaxOccurs: - isGeneric: true isAttribute: true isEnum: false isDataType: true
// --------------------------------------------------------------------------------------------------------||
/**
* Sets the allocation-size attribute
* @param allocationSize the value for the attribute allocation-size
* @return the current instance of TableGenerator
*/
public TableGenerator allocationSize(Integer allocationSize);
/**
* Returns the allocation-size attribute
* @return the value defined for the attribute allocation-size
*/
public Integer getAllocationSize();
/**
* Removes the allocation-size attribute
* @return the current instance of TableGenerator
*/
public TableGenerator removeAllocationSize();
}