org.jboss.shrinkwrap.descriptor.api.orm20

Interface SqlResultSetMapping<T>

All Superinterfaces:

Child<T>, OrmSqlResultSetMappingCommType<T,SqlResultSetMapping<T>,EntityResult<SqlResultSetMapping<T>>,ColumnResult<SqlResultSetMapping<T>>>

public interface SqlResultSetMapping<T>
extends Child<T>, OrmSqlResultSetMappingCommType<T,SqlResultSetMapping<T>,EntityResult<SqlResultSetMapping<T>>,ColumnResult<SqlResultSetMapping<T>>>

This interface defines the contract for the sql-result-set-mapping xsd type

Author:

Ralf Battenfeld, Andrew Lee Rubinger, George Gastaldi

Method Summary

Modifier and Type	Method and Description
ColumnResult<SqlResultSetMapping<T>>	createColumnResult() Creates a new column-result element
EntityResult<SqlResultSetMapping<T>>	createEntityResult() Creates a new entity-result element
SqlResultSetMapping<T>	description(String description) Sets the description element
List<ColumnResult<SqlResultSetMapping<T>>>	getAllColumnResult() Returns all column-result elements
List<EntityResult<SqlResultSetMapping<T>>>	getAllEntityResult() Returns all entity-result elements
String	getDescription() Returns the description element
String	getName() Returns the name attribute
ColumnResult<SqlResultSetMapping<T>>	getOrCreateColumnResult() If not already created, a new column-result element will be created and returned.
EntityResult<SqlResultSetMapping<T>>	getOrCreateEntityResult() If not already created, a new entity-result element will be created and returned.
SqlResultSetMapping<T>	name(String name) Sets the name attribute
SqlResultSetMapping<T>	removeAllColumnResult() Removes all column-result elements
SqlResultSetMapping<T>	removeAllEntityResult() Removes all entity-result elements
SqlResultSetMapping<T>	removeDescription() Removes the description element
SqlResultSetMapping<T>	removeName() Removes the name attribute

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

up

Method Detail

description

SqlResultSetMapping<T> description(String description)

Sets the description element

Parameters:

description - the value for the element description

Returns:

the current instance of SqlResultSetMapping

getDescription

String getDescription()

Returns the description element

Returns:

the node defined for the element description

removeDescription

SqlResultSetMapping<T> removeDescription()

Removes the description element

Returns:

the current instance of SqlResultSetMapping

getOrCreateEntityResult

EntityResult<SqlResultSetMapping<T>> getOrCreateEntityResult()

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

Returns:

the instance defined for the element entity-result

createEntityResult

EntityResult<SqlResultSetMapping<T>> createEntityResult()

Creates a new entity-result element

Returns:

the new created instance of EntityResult>

getAllEntityResult

List<EntityResult<SqlResultSetMapping<T>>> getAllEntityResult()

Returns all entity-result elements

Returns:

list of entity-result

removeAllEntityResult

SqlResultSetMapping<T> removeAllEntityResult()

Removes all entity-result elements

Returns:

the current instance of EntityResult>

getOrCreateColumnResult

ColumnResult<SqlResultSetMapping<T>> getOrCreateColumnResult()

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

Returns:

the instance defined for the element column-result

createColumnResult

ColumnResult<SqlResultSetMapping<T>> createColumnResult()

Creates a new column-result element

Returns:

the new created instance of ColumnResult>

getAllColumnResult

List<ColumnResult<SqlResultSetMapping<T>>> getAllColumnResult()

Returns all column-result elements

Returns:

list of column-result

removeAllColumnResult

SqlResultSetMapping<T> removeAllColumnResult()

Removes all column-result elements

Returns:

the current instance of ColumnResult>

name

SqlResultSetMapping<T> name(String name)

Sets the name attribute

Parameters:

name - the value for the attribute name

Returns:

the current instance of SqlResultSetMapping

getName

String getName()

Returns the name attribute

Returns:

the value defined for the attribute name

removeName

SqlResultSetMapping<T> removeName()

Removes the name attribute

Returns:

the current instance of SqlResultSetMapping