org.jboss.shrinkwrap.descriptor.api.ejbjar30

Interface QueryType<T>

All Superinterfaces:

Child<T>, JavaeeQueryCommonType<T,QueryType<T>,QueryMethodType<QueryType<T>>>

public interface QueryType<T>
extends Child<T>, JavaeeQueryCommonType<T,QueryType<T>,QueryMethodType<QueryType<T>>>

This interface defines the contract for the queryType xsd type

Author:

Ralf Battenfeld, Andrew Lee Rubinger, George Gastaldi

Method Summary

Modifier and Type	Method and Description
QueryType<T>	description(String description) Sets the description element
QueryType<T>	ejbQl(String ejbQl) Sets the ejb-ql element
String	getDescription() Returns the description element
String	getEjbQl() Returns the ejb-ql element
String	getId() Returns the id attribute
QueryMethodType<QueryType<T>>	getOrCreateQueryMethod() If not already created, a new query-method element with the given value will be created.
ResultTypeMappingType	getResultTypeMapping() Returns the result-type-mapping element
String	getResultTypeMappingAsString() Returns the result-type-mapping element
QueryType<T>	id(String id) Sets the id attribute
QueryType<T>	removeDescription() Removes the description element
QueryType<T>	removeEjbQl() Removes the ejb-ql element
QueryType<T>	removeId() Removes the id attribute
QueryType<T>	removeQueryMethod() Removes the query-method element
QueryType<T>	removeResultTypeMapping() Removes the result-type-mapping attribute
QueryType<T>	resultTypeMapping(ResultTypeMappingType resultTypeMapping) Sets the result-type-mapping element
QueryType<T>	resultTypeMapping(String resultTypeMapping) Sets the result-type-mapping element

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

up

Method Detail

description

QueryType<T> description(String description)

Sets the description element

Parameters:

description - the value for the element description

Returns:

the current instance of QueryType

getDescription

String getDescription()

Returns the description element

Returns:

the node defined for the element description

removeDescription

QueryType<T> removeDescription()

Removes the description element

Returns:

the current instance of QueryType

getOrCreateQueryMethod

QueryMethodType<QueryType<T>> getOrCreateQueryMethod()

If not already created, a new query-method element with the given value will be created. Otherwise, the existing query-method element will be returned.

Returns:

a new or existing instance of QueryMethodType>

removeQueryMethod

QueryType<T> removeQueryMethod()

Removes the query-method element

Returns:

the current instance of QueryType

resultTypeMapping

QueryType<T> resultTypeMapping(ResultTypeMappingType resultTypeMapping)

Sets the result-type-mapping element

Parameters:

resultTypeMapping - the value for the element result-type-mapping

Returns:

the current instance of QueryType

resultTypeMapping

QueryType<T> resultTypeMapping(String resultTypeMapping)

Sets the result-type-mapping element

Parameters:

resultTypeMapping - the value for the element result-type-mapping

Returns:

the current instance of QueryType

getResultTypeMapping

ResultTypeMappingType getResultTypeMapping()

Returns the result-type-mapping element

Returns:

the value found for the element result-type-mapping

getResultTypeMappingAsString

String getResultTypeMappingAsString()

Returns the result-type-mapping element

Returns:

the value found for the element result-type-mapping

removeResultTypeMapping

QueryType<T> removeResultTypeMapping()

Removes the result-type-mapping attribute

Returns:

the current instance of QueryType

ejbQl

QueryType<T> ejbQl(String ejbQl)

Sets the ejb-ql element

Parameters:

ejbQl - the value for the element ejb-ql

Returns:

the current instance of QueryType

getEjbQl

String getEjbQl()

Returns the ejb-ql element

Returns:

the node defined for the element ejb-ql

removeEjbQl

QueryType<T> removeEjbQl()

Removes the ejb-ql element

Returns:

the current instance of QueryType

id

QueryType<T> id(String id)

Sets the id attribute

Parameters:

id - the value for the attribute id

Returns:

the current instance of QueryType

getId

String getId()

Returns the id attribute

Returns:

the value defined for the attribute id

removeId

QueryType<T> removeId()

Removes the id attribute

Returns:

the current instance of QueryType