Top Description Methods

org.eclipse.persistence.annotations

public @Interface StoredProcedureParameter

Annotations

extends Annotation

@Target
@Retention:RUNTIME

Imports

java.lang.annotation.Retention, .Target, jakarta.persistence.ParameterMode

A StoredProcedureParameter annotation is used within a NamedStoredProcedureQuery annotation.

Author: Guy Pelletier
Since: Oracle TopLink 11.1.1.0.0
See Also: org.eclipse.persistence.annotations.NamedStoredProcedureQuery

Method Summary

Modifier and Type	Method and Description
public Direction	direction() Deprecated (Optional) The direction of the stored procedure parameter.
public int	jdbcType() (Optional) The JDBC type code, this is dependent on the type returned from the procedure.
public String	jdbcTypeName() (Optional) The JDBC type name, this may be required for ARRAY or STRUCT types.
public ParameterMode	mode() (Optional) The direction of the stored procedure parameter.
public String	name() (Optional) Stored procedure parameter name.
public boolean	optional() (Optional) Define if the parameter is required, or optional and defaulted by the procedure.
public String	queryParameter() (Required) The query parameter name.
public Class<?>	type() (Optional) The type of Java class desired back from the procedure, this is dependent on the type returned from the procedure.

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

Method Detail

direction back to summary

public Direction direction()

Deprecated

(Optional) The direction of the stored procedure parameter.

Annotations

@Deprecated

See Also

jdbcType	back to summary
public int jdbcType() (Optional) The JDBC type code, this is dependent on the type returned from the procedure.

jdbcTypeName	back to summary
public String jdbcTypeName() (Optional) The JDBC type name, this may be required for ARRAY or STRUCT types.

mode	back to summary
public ParameterMode mode() (Optional) The direction of the stored procedure parameter.

name	back to summary
public String name() (Optional) Stored procedure parameter name.

optional	back to summary
public boolean optional() (Optional) Define if the parameter is required, or optional and defaulted by the procedure.

queryParameter	back to summary
public String queryParameter() (Required) The query parameter name.

type	back to summary
public Class<?> type() (Optional) The type of Java class desired back from the procedure, this is dependent on the type returned from the procedure.