ShrinkWrap Descriptors Generated Java EE API 2.0.0-alpha-3

org.jboss.shrinkwrap.descriptor.api.orm10
Interface NamedQuery<T>

All Superinterfaces:
Child<T>

public interface NamedQuery<T>
extends Child<T>

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

Since:
Generation date :2012-05-09T23:45:03.702-07:00
Author:
Ralf Battenfeld, Andrew Lee Rubinger

Method Summary
 QueryHint<NamedQuery<T>> createHint()
          Creates a new hint element
 List<QueryHint<NamedQuery<T>>> getAllHint()
          Returns all hint elements
 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> 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> 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

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

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

ShrinkWrap Descriptors Generated Java EE API 2.0.0-alpha-3

Copyright © 2012 JBoss by Red Hat. All Rights Reserved.