FileDocCategorySizeDatePackage
NativeSQLQueryNonScalarReturn.javaAPI DocHibernate 3.2.51797Thu Jun 15 00:21:06 BST 2006org.hibernate.engine.query.sql

NativeSQLQueryNonScalarReturn

public abstract class NativeSQLQueryNonScalarReturn extends Object implements Serializable, NativeSQLQueryReturn
Represents the base information for a non-scalar return defined as part of a native sql query.
author
Steve Ebersole

Fields Summary
private final String
alias
private final org.hibernate.LockMode
lockMode
private final Map
propertyResults
Constructors Summary
protected NativeSQLQueryNonScalarReturn(String alias, Map propertyResults, org.hibernate.LockMode lockMode)
Constructs some form of non-scalar return descriptor

param
alias The result alias
param
propertyResults Any user-supplied column->property mappings
param
lockMode The lock mode to apply to the return.


	                            	 
	       
		this.alias = alias;
		if ( alias == null ) {
			throw new HibernateException("alias must be specified");
		}
		this.lockMode = lockMode;
		if ( propertyResults != null ) {
			this.propertyResults.putAll( propertyResults );
		}
	
Methods Summary
public java.lang.StringgetAlias()
Retrieve the defined result alias

return
The result alias.

		return alias;
	
public org.hibernate.LockModegetLockMode()
Retrieve the lock-mode to apply to this return

return
The lock mode

		return lockMode;
	
public java.util.MapgetPropertyResultsMap()
Retrieve the user-supplied column->property mappings.

return
The property mappings.

		return Collections.unmodifiableMap( propertyResults );