org.jboss.shrinkwrap.descriptor.api.orm10.Basic 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.TemporalType;
import org.jboss.shrinkwrap.descriptor.api.orm10.EnumType;
import org.jboss.shrinkwrap.descriptor.api.orm10.FetchType;
import org.jboss.shrinkwrap.descriptor.api.orm.*;
import org.jboss.shrinkwrap.descriptor.api.orm.OrmBasicCommType;
import org.jboss.shrinkwrap.descriptor.api.orm10.Column;/**
* This interface defines the contract for the basic
xsd type
* @author Ralf Battenfeld
* @author Andrew Lee Rubinger
* @author George Gastaldi
*/
public interface Basic extends Child,
OrmBasicCommType,
Column>> {
// --------------------------------------------------------------------------------------------------------||
// ClassName: Basic 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 Basic
*/
public Basic removeColumn();
// --------------------------------------------------------------------------------------------------------||
// ClassName: Basic ElementName: javaee:emptyType ElementType : lob
// MaxOccurs: - isGeneric: true isAttribute: false isEnum: false isDataType: true
// --------------------------------------------------------------------------------------------------------||
/**
* Sets the lob
element
* @return the current instance of Basic
*/
public Basic lob();
/**
* Removes the lob
element
* @return the current instance of Basic
*/
public Boolean isLob();
/**
* Removes the lob
element
* @return the current instance of Basic
*/
public Basic removeLob();
// --------------------------------------------------------------------------------------------------------||
// ClassName: Basic 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 Basic
*/
public Basic temporal(TemporalType temporal);
/**
* Sets the temporal
element
* @param temporal the value for the element temporal
* @return the current instance of Basic
*/
public Basic 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 Basic
*/
public Basic removeTemporal();
// --------------------------------------------------------------------------------------------------------||
// ClassName: Basic ElementName: orm:enum-type ElementType : enumerated
// MaxOccurs: - isGeneric: true isAttribute: false isEnum: true isDataType: false
// --------------------------------------------------------------------------------------------------------||
/**
* Sets the enumerated
element
* @param enumerated the value for the element enumerated
* @return the current instance of Basic
*/
public Basic enumerated(EnumType enumerated);
/**
* Sets the enumerated
element
* @param enumerated the value for the element enumerated
* @return the current instance of Basic
*/
public Basic enumerated(String enumerated);
/**
* Returns the enumerated
element
* @return the value found for the element enumerated
*/
public EnumType getEnumerated();
/**
* Returns the enumerated
element
* @return the value found for the element enumerated
*/
public String getEnumeratedAsString();
/**
* Removes the enumerated
attribute
* @return the current instance of Basic
*/
public Basic removeEnumerated();
// --------------------------------------------------------------------------------------------------------||
// ClassName: Basic 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 Basic
*/
public Basic 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 Basic
*/
public Basic removeName();
// --------------------------------------------------------------------------------------------------------||
// ClassName: Basic ElementName: orm:fetch-type ElementType : fetch
// MaxOccurs: - isGeneric: true isAttribute: true isEnum: true isDataType: false
// --------------------------------------------------------------------------------------------------------||
/**
* Sets the fetch
attribute
* @param fetch the value for the attribute fetch
* @return the current instance of Basic
*/
public Basic fetch(FetchType fetch);
/**
* Sets the fetch
attribute
* @param fetch the value for the attribute fetch
* @return the current instance of Basic
*/
public Basic fetch(String fetch);
/**
* Returns the fetch
attribute
* @return the value defined for the attribute fetch
*/
public FetchType getFetch();
/**
* Returns the fetch
attribute
* @return the value found for the element fetch
*/
public String getFetchAsString();
/**
* Removes the fetch
attribute
* @return the current instance of Basic
*/
public Basic removeFetch();
// --------------------------------------------------------------------------------------------------------||
// ClassName: Basic ElementName: xsd:boolean ElementType : optional
// MaxOccurs: - isGeneric: true isAttribute: true isEnum: false isDataType: true
// --------------------------------------------------------------------------------------------------------||
/**
* Sets the optional
attribute
* @param optional the value for the attribute optional
* @return the current instance of Basic
*/
public Basic optional(Boolean optional);
/**
* Returns the optional
attribute
* @return the value defined for the attribute optional
*/
public Boolean isOptional();
/**
* Removes the optional
attribute
* @return the current instance of Basic
*/
public Basic removeOptional();
}