org.jboss.shrinkwrap.descriptor.api.orm20

Interface NamedNativeQuery<T>

All Superinterfaces:

Child<T>, OrmNamedNativeQueryCommType<T,NamedNativeQuery<T>,QueryHint<NamedNativeQuery<T>>>

public interface NamedNativeQuery<T>
extends Child<T>, OrmNamedNativeQueryCommType<T,NamedNativeQuery<T>,QueryHint<NamedNativeQuery<T>>>

This interface defines the contract for the named-native-query xsd type

Author:

Ralf Battenfeld, Andrew Lee Rubinger, George Gastaldi

Method Summary

Modifier and Type	Method and Description
QueryHint<NamedNativeQuery<T>>	createHint() Creates a new hint element
NamedNativeQuery<T>	description(String description) Sets the description element
List<QueryHint<NamedNativeQuery<T>>>	getAllHint() Returns all hint elements
String	getDescription() Returns the description element
String	getName() Returns the name attribute
QueryHint<NamedNativeQuery<T>>	getOrCreateHint() If not already created, a new hint element will be created and returned.
String	getQuery() Returns the query element
String	getResultClass() Returns the result-class attribute
String	getResultSetMapping() Returns the result-set-mapping attribute
NamedNativeQuery<T>	name(String name) Sets the name attribute
NamedNativeQuery<T>	query(String query) Sets the query element
NamedNativeQuery<T>	removeAllHint() Removes all hint elements
NamedNativeQuery<T>	removeDescription() Removes the description element
NamedNativeQuery<T>	removeName() Removes the name attribute
NamedNativeQuery<T>	removeQuery() Removes the query element
NamedNativeQuery<T>	removeResultClass() Removes the result-class attribute
NamedNativeQuery<T>	removeResultSetMapping() Removes the result-set-mapping attribute
NamedNativeQuery<T>	resultClass(String resultClass) Sets the result-class attribute
NamedNativeQuery<T>	resultSetMapping(String resultSetMapping) Sets the result-set-mapping attribute

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

up

Method Detail

description

NamedNativeQuery<T> description(String description)

Sets the description element

Parameters:

description - the value for the element description

Returns:

the current instance of NamedNativeQuery

getDescription

String getDescription()

Returns the description element

Returns:

the node defined for the element description

removeDescription

NamedNativeQuery<T> removeDescription()

Removes the description element

Returns:

the current instance of NamedNativeQuery

query

NamedNativeQuery<T> query(String query)

Sets the query element

Parameters:

query - the value for the element query

Returns:

the current instance of NamedNativeQuery

getQuery

String getQuery()

Returns the query element

Returns:

the node defined for the element query

removeQuery

NamedNativeQuery<T> removeQuery()

Removes the query element

Returns:

the current instance of NamedNativeQuery

getOrCreateHint

QueryHint<NamedNativeQuery<T>> getOrCreateHint()

If not already created, a new hint element will be created and returned. Otherwise, the first existing hint element will be returned.

Returns:

the instance defined for the element hint

createHint

QueryHint<NamedNativeQuery<T>> createHint()

Creates a new hint element

Returns:

the new created instance of QueryHint>

getAllHint

List<QueryHint<NamedNativeQuery<T>>> getAllHint()

Returns all hint elements

Returns:

list of hint

removeAllHint

NamedNativeQuery<T> removeAllHint()

Removes all hint elements

Returns:

the current instance of QueryHint>

name

NamedNativeQuery<T> name(String name)

Sets the name attribute

Parameters:

name - the value for the attribute name

Returns:

the current instance of NamedNativeQuery

getName

String getName()

Returns the name attribute

Returns:

the value defined for the attribute name

removeName

NamedNativeQuery<T> removeName()

Removes the name attribute

Returns:

the current instance of NamedNativeQuery

resultClass

NamedNativeQuery<T> resultClass(String resultClass)

Sets the result-class attribute

Parameters:

resultClass - the value for the attribute result-class

Returns:

the current instance of NamedNativeQuery

getResultClass

String getResultClass()

Returns the result-class attribute

Returns:

the value defined for the attribute result-class

removeResultClass

NamedNativeQuery<T> removeResultClass()

Removes the result-class attribute

Returns:

the current instance of NamedNativeQuery

resultSetMapping

NamedNativeQuery<T> resultSetMapping(String resultSetMapping)

Sets the result-set-mapping attribute

Parameters:

resultSetMapping - the value for the attribute result-set-mapping

Returns:

the current instance of NamedNativeQuery

getResultSetMapping

String getResultSetMapping()

Returns the result-set-mapping attribute

Returns:

the value defined for the attribute result-set-mapping

removeResultSetMapping

NamedNativeQuery<T> removeResultSetMapping()

Removes the result-set-mapping attribute

Returns:

the current instance of NamedNativeQuery