Skip navigation links

Oracle Fusion Middleware Java API Reference for Oracle TopLink
11g Release 1 (11.1.1)

E28847-01


org.eclipse.persistence.annotations
Annotation Type StoredProcedureParameter


@Target(value={})
@Retention(value=RUNTIME)
public @interface StoredProcedureParameter

A StoredProcedureParameter annotation is used within a NamedStoredProcedureQuery annotation.

Since:
Oracle TopLink 11.1.1.0.0
Author:
Guy Pelletier
See Also:
NamedStoredProcedureQuery

Required Element Summary
 java.lang.String queryParameter
          (Required) The query parameter name.

 

Optional Element Summary
 Direction direction
          (Optional) The direction of the stored procedure parameter.
 int jdbcType
          (Optional) The JDBC type code, this is dependent on the type returned from the procedure.
 java.lang.String jdbcTypeName
          (Optional) The JDBC type name, this may be required for ARRAY or STRUCT types.
 java.lang.String name
          (Optional) Stored procedure parameter name.
 boolean optional
          (Optional) Define if the parameter is required, or optional and defaulted by the procedure.
 java.lang.Class type
          (Optional) The type of Java class desired back from the procedure, this is dependent on the type returned from the procedure.

 

Element Detail

queryParameter

public abstract java.lang.String queryParameter
(Required) The query parameter name.

direction

public abstract Direction direction
(Optional) The direction of the stored procedure parameter.
Default:
org.eclipse.persistence.annotations.Direction.IN

name

public abstract java.lang.String name
(Optional) Stored procedure parameter name.
Default:
""

optional

public abstract boolean optional
(Optional) Define if the parameter is required, or optional and defaulted by the procedure.
Default:
false

type

public abstract java.lang.Class type
(Optional) The type of Java class desired back from the procedure, this is dependent on the type returned from the procedure.
Default:
void.class

jdbcType

public abstract int jdbcType
(Optional) The JDBC type code, this is dependent on the type returned from the procedure.
Default:
-1

jdbcTypeName

public abstract java.lang.String jdbcTypeName
(Optional) The JDBC type name, this may be required for ARRAY or STRUCT types.
Default:
""

Skip navigation links

Copyright © 1998, 2012, Oracle. All Rights Reserved.