NamedStoredProcedureQuery (ShrinkWrap Descriptors Aggregator 2.0.0 API)

All Superinterfaces:

Child<T>, OrmNamedStoredProcedureQueryCommType<T,NamedStoredProcedureQuery<T>,StoredProcedureParameter<NamedStoredProcedureQuery<T>>,QueryHint<NamedStoredProcedureQuery<T>>>
```
public interface NamedStoredProcedureQuery<T>
extends Child<T>, OrmNamedStoredProcedureQueryCommType<T,NamedStoredProcedureQuery<T>,StoredProcedureParameter<NamedStoredProcedureQuery<T>>,QueryHint<NamedStoredProcedureQuery<T>>>
```
This interface defines the contract for the named-stored-procedure-query xsd type

Author:

Ralf Battenfeld, Andrew Lee Rubinger

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`QueryHint<NamedStoredProcedureQuery<T>>`	`createHint()` Creates a new `hint` element
`StoredProcedureParameter<NamedStoredProcedureQuery<T>>`	`createParameter()` Creates a new `parameter` element
`NamedStoredProcedureQuery<T>`	`description(String description)` Sets the `description` element
`List<QueryHint<NamedStoredProcedureQuery<T>>>`	`getAllHint()` Returns all `hint` elements
`List<StoredProcedureParameter<NamedStoredProcedureQuery<T>>>`	`getAllParameter()` Returns all `parameter` elements
`List<String>`	`getAllResultClass()` Returns all `result-class` elements
`List<String>`	`getAllResultSetMapping()` Returns all `result-set-mapping` elements
`String`	`getDescription()` Returns the `description` element
`String`	`getName()` Returns the `name` attribute
`QueryHint<NamedStoredProcedureQuery<T>>`	`getOrCreateHint()` If not already created, a new `hint` element will be created and returned.
`StoredProcedureParameter<NamedStoredProcedureQuery<T>>`	`getOrCreateParameter()` If not already created, a new `parameter` element will be created and returned.
`String`	`getProcedureName()` Returns the `procedure-name` attribute
`NamedStoredProcedureQuery<T>`	`name(String name)` Sets the `name` attribute
`NamedStoredProcedureQuery<T>`	`procedureName(String procedureName)` Sets the `procedure-name` attribute
`NamedStoredProcedureQuery<T>`	`removeAllHint()` Removes all `hint` elements
`NamedStoredProcedureQuery<T>`	`removeAllParameter()` Removes all `parameter` elements
`NamedStoredProcedureQuery<T>`	`removeAllResultClass()` Removes the `result-class` element
`NamedStoredProcedureQuery<T>`	`removeAllResultSetMapping()` Removes the `result-set-mapping` element
`NamedStoredProcedureQuery<T>`	`removeDescription()` Removes the `description` element
`NamedStoredProcedureQuery<T>`	`removeName()` Removes the `name` attribute
`NamedStoredProcedureQuery<T>`	`removeProcedureName()` Removes the `procedure-name` attribute
`NamedStoredProcedureQuery<T>`	`resultClass(String... values)` Creates for all String objects representing `result-class` elements, a new `result-class` element
`NamedStoredProcedureQuery<T>`	`resultSetMapping(String... values)` Creates for all String objects representing `result-set-mapping` elements, a new `result-set-mapping` element

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

- Method Detail
  - description
```
NamedStoredProcedureQuery<T> description(String description)
```
    Sets the description element
    
    Parameters:
    
    description - the value for the element description
    
    Returns:
    
    the current instance of NamedStoredProcedureQuery
  - getDescription
```
String getDescription()
```
    Returns the description element
    
    Returns:
    
    the node defined for the element description
  - removeDescription
```
NamedStoredProcedureQuery<T> removeDescription()
```
    Removes the description element
    
    Returns:
    
    the current instance of NamedStoredProcedureQuery
  - getOrCreateParameter
```
StoredProcedureParameter<NamedStoredProcedureQuery<T>> getOrCreateParameter()
```
    If not already created, a new parameter element will be created and returned. Otherwise, the first existing parameter element will be returned.
    
    Returns:
    
    the instance defined for the element parameter
  - createParameter
```
StoredProcedureParameter<NamedStoredProcedureQuery<T>> createParameter()
```
    Creates a new parameter element
    
    Returns:
    
    the new created instance of StoredProcedureParameter>
  - getAllParameter
```
List<StoredProcedureParameter<NamedStoredProcedureQuery<T>>> getAllParameter()
```
    Returns all parameter elements
    
    Returns:
    
    list of parameter
  - removeAllParameter
```
NamedStoredProcedureQuery<T> removeAllParameter()
```
    Removes all parameter elements
    
    Returns:
    
    the current instance of StoredProcedureParameter>
  - resultClass
```
NamedStoredProcedureQuery<T> resultClass(String... values)
```
    Creates for all String objects representing result-class elements, a new result-class element
    
    Parameters:
    
    values - list of result-class objects
    
    Returns:
    
    the current instance of NamedStoredProcedureQuery
  - getAllResultClass
```
List<String> getAllResultClass()
```
    Returns all result-class elements
    
    Returns:
    
    list of result-class
  - removeAllResultClass
```
NamedStoredProcedureQuery<T> removeAllResultClass()
```
    Removes the result-class element
    
    Returns:
    
    the current instance of NamedStoredProcedureQuery
  - resultSetMapping
```
NamedStoredProcedureQuery<T> resultSetMapping(String... values)
```
    Creates for all String objects representing result-set-mapping elements, a new result-set-mapping element
    
    Parameters:
    
    values - list of result-set-mapping objects
    
    Returns:
    
    the current instance of NamedStoredProcedureQuery
  - getAllResultSetMapping
```
List<String> getAllResultSetMapping()
```
    Returns all result-set-mapping elements
    
    Returns:
    
    list of result-set-mapping
  - removeAllResultSetMapping
```
NamedStoredProcedureQuery<T> removeAllResultSetMapping()
```
    Removes the result-set-mapping element
    
    Returns:
    
    the current instance of NamedStoredProcedureQuery
  - getOrCreateHint
```
QueryHint<NamedStoredProcedureQuery<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<NamedStoredProcedureQuery<T>> createHint()
```
    Creates a new hint element
    
    Returns:
    
    the new created instance of QueryHint>
  - getAllHint
```
List<QueryHint<NamedStoredProcedureQuery<T>>> getAllHint()
```
    Returns all hint elements
    
    Returns:
    
    list of hint
  - removeAllHint
```
NamedStoredProcedureQuery<T> removeAllHint()
```
    Removes all hint elements
    
    Returns:
    
    the current instance of QueryHint>
  - name
```
NamedStoredProcedureQuery<T> name(String name)
```
    Sets the name attribute
    
    Parameters:
    
    name - the value for the attribute name
    
    Returns:
    
    the current instance of NamedStoredProcedureQuery
  - getName
```
String getName()
```
    Returns the name attribute
    
    Returns:
    
    the value defined for the attribute name
  - removeName
```
NamedStoredProcedureQuery<T> removeName()
```
    Removes the name attribute
    
    Returns:
    
    the current instance of NamedStoredProcedureQuery
  - procedureName
```
NamedStoredProcedureQuery<T> procedureName(String procedureName)
```
    Sets the procedure-name attribute
    
    Parameters:
    
    procedureName - the value for the attribute procedure-name
    
    Returns:
    
    the current instance of NamedStoredProcedureQuery
  - getProcedureName
```
String getProcedureName()
```
    Returns the procedure-name attribute
    
    Returns:
    
    the value defined for the attribute procedure-name
  - removeProcedureName
```
NamedStoredProcedureQuery<T> removeProcedureName()
```
    Removes the procedure-name attribute
    
    Returns:
    
    the current instance of NamedStoredProcedureQuery

Interface NamedStoredProcedureQuery<T>

Method Summary

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

Method Detail

description

getDescription

removeDescription

getOrCreateParameter

createParameter

getAllParameter

removeAllParameter

resultClass

getAllResultClass

removeAllResultClass

resultSetMapping

getAllResultSetMapping

removeAllResultSetMapping

getOrCreateHint

createHint

getAllHint

removeAllHint

name

getName

removeName

procedureName

getProcedureName

removeProcedureName