org.jboss.shrinkwrap.descriptor.api.orm21.NamedNativeQuery 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.orm21;
import java.util.ArrayList;
import java.util.List;
import org.jboss.shrinkwrap.descriptor.api.Child;
import org.jboss.shrinkwrap.descriptor.api.orm21.QueryHint;
import org.jboss.shrinkwrap.descriptor.api.orm.*;
import org.jboss.shrinkwrap.descriptor.api.orm.OrmNamedNativeQueryCommType;
import org.jboss.shrinkwrap.descriptor.api.orm21.QueryHint;/**
* This interface defines the contract for the named-native-query
xsd type
* @author Ralf Battenfeld
* @author Andrew Lee Rubinger
*/
public interface NamedNativeQuery extends Child,
OrmNamedNativeQueryCommType,
QueryHint>> {
// --------------------------------------------------------------------------------------------------------||
// ClassName: NamedNativeQuery 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 NamedNativeQuery
*/
public NamedNativeQuery 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 NamedNativeQuery
*/
public NamedNativeQuery removeDescription();
// --------------------------------------------------------------------------------------------------------||
// ClassName: NamedNativeQuery ElementName: xsd:string ElementType : query
// MaxOccurs: - isGeneric: true isAttribute: false isEnum: false isDataType: true
// --------------------------------------------------------------------------------------------------------||
/**
* Sets the query
element
* @param query the value for the element query
* @return the current instance of NamedNativeQuery
*/
public NamedNativeQuery query(String query);
/**
* Returns the query
element
* @return the node defined for the element query
*/
public String getQuery();
/**
* Removes the query
element
* @return the current instance of NamedNativeQuery
*/
public NamedNativeQuery removeQuery();
// --------------------------------------------------------------------------------------------------------||
// ClassName: NamedNativeQuery ElementName: orm:query-hint ElementType : hint
// MaxOccurs: -unbounded isGeneric: true isAttribute: false isEnum: false isDataType: false
// --------------------------------------------------------------------------------------------------------||
/**
* If not already created, a new hint
element will be created and returned.
* Otherwise, the first existing hint
element will be returned.
* @return the instance defined for the element hint
*/
public QueryHint> getOrCreateHint();
/**
* Creates a new hint
element
* @return the new created instance of QueryHint>
*/
public QueryHint> createHint();
/**
* Returns all hint
elements
* @return list of hint
*/
public List>> getAllHint();
/**
* Removes all hint
elements
* @return the current instance of QueryHint>
*/
public NamedNativeQuery removeAllHint();
// --------------------------------------------------------------------------------------------------------||
// ClassName: NamedNativeQuery 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 NamedNativeQuery
*/
public NamedNativeQuery 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 NamedNativeQuery
*/
public NamedNativeQuery removeName();
// --------------------------------------------------------------------------------------------------------||
// ClassName: NamedNativeQuery ElementName: xsd:string ElementType : result-class
// MaxOccurs: - isGeneric: true isAttribute: true isEnum: false isDataType: true
// --------------------------------------------------------------------------------------------------------||
/**
* Sets the result-class
attribute
* @param resultClass the value for the attribute result-class
* @return the current instance of NamedNativeQuery
*/
public NamedNativeQuery resultClass(String resultClass);
/**
* Returns the result-class
attribute
* @return the value defined for the attribute result-class
*/
public String getResultClass();
/**
* Removes the result-class
attribute
* @return the current instance of NamedNativeQuery
*/
public NamedNativeQuery removeResultClass();
// --------------------------------------------------------------------------------------------------------||
// ClassName: NamedNativeQuery ElementName: xsd:string ElementType : result-set-mapping
// MaxOccurs: - isGeneric: true isAttribute: true isEnum: false isDataType: true
// --------------------------------------------------------------------------------------------------------||
/**
* Sets the result-set-mapping
attribute
* @param resultSetMapping the value for the attribute result-set-mapping
* @return the current instance of NamedNativeQuery
*/
public NamedNativeQuery resultSetMapping(String resultSetMapping);
/**
* Returns the result-set-mapping
attribute
* @return the value defined for the attribute result-set-mapping
*/
public String getResultSetMapping();
/**
* Removes the result-set-mapping
attribute
* @return the current instance of NamedNativeQuery
*/
public NamedNativeQuery removeResultSetMapping();
}