org.jboss.shrinkwrap.descriptor.api.orm20

Interface NamedQuery<T>

All Superinterfaces:

Child<T>, OrmNamedQueryCommType<T,NamedQuery<T>,QueryHint<NamedQuery<T>>>

public interface NamedQuery<T>
extends Child<T>, OrmNamedQueryCommType<T,NamedQuery<T>,QueryHint<NamedQuery<T>>>

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

Author:

Ralf Battenfeld, Andrew Lee Rubinger, George Gastaldi

Method Summary

Modifier and Type	Method and Description
QueryHint<NamedQuery<T>>	createHint() Creates a new hint element
NamedQuery<T>	description(String description) Sets the description element
List<QueryHint<NamedQuery<T>>>	getAllHint() Returns all hint elements
String	getDescription() Returns the description element
LockModeType	getLockMode() Returns the lock-mode element
String	getLockModeAsString() Returns the lock-mode element
String	getName() Returns the name attribute
QueryHint<NamedQuery<T>>	getOrCreateHint() If not already created, a new hint element will be created and returned.
String	getQuery() Returns the query element
NamedQuery<T>	lockMode(LockModeType lockMode) Sets the lock-mode element
NamedQuery<T>	lockMode(String lockMode) Sets the lock-mode element
NamedQuery<T>	name(String name) Sets the name attribute
NamedQuery<T>	query(String query) Sets the query element
NamedQuery<T>	removeAllHint() Removes all hint elements
NamedQuery<T>	removeDescription() Removes the description element
NamedQuery<T>	removeLockMode() Removes the lock-mode attribute
NamedQuery<T>	removeName() Removes the name attribute
NamedQuery<T>	removeQuery() Removes the query element

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

up

Method Detail

description

NamedQuery<T> description(String description)

Sets the description element

Parameters:

description - the value for the element description

Returns:

the current instance of NamedQuery

getDescription

String getDescription()

Returns the description element

Returns:

the node defined for the element description

removeDescription

NamedQuery<T> removeDescription()

Removes the description element

Returns:

the current instance of NamedQuery

query

NamedQuery<T> query(String query)

Sets the query element

Parameters:

query - the value for the element query

Returns:

the current instance of NamedQuery

getQuery

String getQuery()

Returns the query element

Returns:

the node defined for the element query

removeQuery

NamedQuery<T> removeQuery()

Removes the query element

Returns:

the current instance of NamedQuery

lockMode

NamedQuery<T> lockMode(LockModeType lockMode)

Sets the lock-mode element

Parameters:

lockMode - the value for the element lock-mode

Returns:

the current instance of NamedQuery

lockMode

NamedQuery<T> lockMode(String lockMode)

Sets the lock-mode element

Parameters:

lockMode - the value for the element lock-mode

Returns:

the current instance of NamedQuery

getLockMode

LockModeType getLockMode()

Returns the lock-mode element

Returns:

the value found for the element lock-mode

getLockModeAsString

String getLockModeAsString()

Returns the lock-mode element

Returns:

the value found for the element lock-mode

removeLockMode

NamedQuery<T> removeLockMode()

Removes the lock-mode attribute

Returns:

the current instance of NamedQuery

getOrCreateHint

QueryHint<NamedQuery<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<NamedQuery<T>> createHint()

Creates a new hint element

Returns:

the new created instance of QueryHint>

getAllHint

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

Returns all hint elements

Returns:

list of hint

removeAllHint

NamedQuery<T> removeAllHint()

Removes all hint elements

Returns:

the current instance of QueryHint>

name

NamedQuery<T> name(String name)

Sets the name attribute

Parameters:

name - the value for the attribute name

Returns:

the current instance of NamedQuery

getName

String getName()

Returns the name attribute

Returns:

the value defined for the attribute name

removeName

NamedQuery<T> removeName()

Removes the name attribute

Returns:

the current instance of NamedQuery