EclipseLink Core 4.0.2 · org.eclipse.persistence.annotations.NamedStoredProcedureQuery

Method Summary

Modifier and Type	Method and Description
public boolean	callByIndex() (Optional) Defines if the stored procedure should be called by index or by name.
public QueryHint[]	hints() (Optional) Query hints.
public boolean	multipleResultSets() (Optional) Defines if the stored procedure returns multiple result sets.
public String	name() (Required) Unique name that references this stored procedure query.
public StoredProcedureParameter[]	parameters() (Optional) Defines the parameters to the stored procedure.
public String	procedureName() (Required) The name of the stored procedure.
public Class<?>	resultClass() Deprecated (Optional) Refers to the class of the result.
public Class<?>[]	resultClasses() (Optional) Refers to the classes of the result.
public String	resultSetMapping() Deprecated (Optional) The name of the SQLResultMapping.
public String[]	resultSetMappings() (Optional) The names of the SQLResultMappings.
public boolean	returnsResultSet() (Optional) Defines if stored procedure returns a result set.

Inherited from java.lang.annotation.Annotation:: annotationType equals hashCode toString

callByIndex	back to summary
public boolean callByIndex() (Optional) Defines if the stored procedure should be called by index or by name. By index requires that the StoredProcedureParameter are defined in the same order as the procedure on the database. By name requires the database platform support naming procedure parameters.

hints	back to summary
public QueryHint[] hints() (Optional) Query hints.

multipleResultSets	back to summary
public boolean multipleResultSets() (Optional) Defines if the stored procedure returns multiple result sets. This is only relevant on databases that support multiple result sets from stored procedures.

name	back to summary
public String name() (Required) Unique name that references this stored procedure query.

parameters	back to summary
public StoredProcedureParameter[] parameters() (Optional) Defines the parameters to the stored procedure.

procedureName	back to summary
public String procedureName() (Required) The name of the stored procedure.

resultClass back to summary

resultClass	back to summary
public Class<?> resultClass() Deprecated (Optional) Refers to the class of the result. Annotations @Deprecated See Also `resultClasses`

public Class<?> resultClass()

Deprecated

(Optional) Refers to the class of the result.

Annotations

See Also

resultClasses

resultClasses	back to summary
public Class<?>[] resultClasses() (Optional) Refers to the classes of the result.

resultSetMapping back to summary

resultSetMapping	back to summary
public String resultSetMapping() Deprecated (Optional) The name of the SQLResultMapping. Annotations @Deprecated See Also `resultSetMappings`

public String resultSetMapping()

Deprecated

(Optional) The name of the SQLResultMapping.

Annotations

See Also

resultSetMappings

resultSetMappings	back to summary
public String[] resultSetMappings() (Optional) The names of the SQLResultMappings.

returnsResultSet	back to summary
public boolean returnsResultSet() (Optional) Defines if stored procedure returns a result set. This is only relevant on databases that support returning result sets from stored procedures.