Overview | Package | Class | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## org.apache.cayenne.map
Class ProcedureParameter

    java.lang.Object
      org.apache.cayenne.map.ProcedureParameter

All Implemented Interfaces:
  java.io.Serializable, CayenneMapEntry, XMLSerializable

    public class ProcedureParameter

extends java.lang.Object
implements CayenneMapEntry, XMLSerializable, java.io.Serializable

A descriptor for the Procedure parameter.

Author:
  Andrei Adamchik
See Also:
  Serialized Form

Field Summary
`protected int` | `direction`
`static int` | `IN_OUT_PARAMETER`
`static int` | `IN_PARAMETER`
`protected int` | `maxLength`
`protected java.lang.String` | `name`
`static int` | `OUT_PARAMETER`
`protected int` | `precision`
`protected Procedure` | `procedure`
`protected int` | `type`

Constructor Summary
`ProcedureParameter()` Creates unnamed ProcedureParameter.
`ProcedureParameter(java.lang.String name)`
`ProcedureParameter(java.lang.String name, int type, int direction)`

Method Summary
`void` | `encodeAsXML(XMLEncoder encoder)` Prints itself as XML to the provided PrintWriter.
`int` | `getDirection()` Returns the direction of this parameter.
`Procedure` | `getEntity()` Deprecated. since 1.2 use getProcedure() instead.
`int` | `getMaxLength()`
`java.lang.String` | `getName()` Returns the name property of this object.
`java.lang.Object` | `getParent()` Returns the parent map.
`int` | `getPrecision()`
`Procedure` | `getProcedure()` Returns the procedure that holds this parameter.
`int` | `getType()`
`boolean` | `isInParameter()`
`boolean` | `isOutParam()`
`void` | `setDirection(int direction)` Sets the direction of this parameter.
`void` | `setMaxLength(int i)`
`void` | `setName(java.lang.String name)`
`void` | `setParent(java.lang.Object parent)` Stores the parent map.
`void` | `setPrecision(int i)`
`void` | `setProcedure(Procedure procedure)` Sets the procedure that holds this parameter.
`void` | `setType(int i)`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Field Detail

### IN_OUT_PARAMETER

    public static final int IN_OUT_PARAMETER

See Also:
  Constant Field Values

### IN_PARAMETER

    public static final int IN_PARAMETER

See Also:
  Constant Field Values

### OUT_PARAMETER

    public static final int OUT_PARAMETER

See Also:
  Constant Field Values

### name

    protected java.lang.String name

### procedure

    protected Procedure procedure

### direction

    protected int direction

### maxLength

    protected int maxLength

### precision

    protected int precision

### type

    protected int type

Constructor Detail

### ProcedureParameter

    public ProcedureParameter()

  Creates unnamed ProcedureParameter.

### ProcedureParameter

    public ProcedureParameter(java.lang.String name)

### ProcedureParameter

    public ProcedureParameter(java.lang.String name,
                              int type,
                              int direction)

Method Detail

### getName

    public java.lang.String getName()

  Description copied from interface: `CayenneMapEntry`
  Returns the name property of this object.

  Specified by:
    `getName` in interface `CayenneMapEntry`
  Returns:
    name of this entry.

### setName

    public void setName(java.lang.String name)

### getParent

    public java.lang.Object getParent()

  Description copied from interface: `CayenneMapEntry`
  Returns the parent map.

  Specified by:
    `getParent` in interface `CayenneMapEntry`

### setParent

    public void setParent(java.lang.Object parent)

  Description copied from interface: `CayenneMapEntry`
  Stores the parent map.

  Specified by:
    `setParent` in interface `CayenneMapEntry`

### encodeAsXML

    public void encodeAsXML(XMLEncoder encoder)

  Prints itself as XML to the provided PrintWriter.

  Specified by:
    `encodeAsXML` in interface `XMLSerializable`
  Since:
    1.1

### getDirection

    public int getDirection()

  Returns the direction of this parameter. Possible values can be IN_PARAMETER, OUT_PARAMETER, IN_OUT_PARAMETER, VOID_PARAMETER.

### getEntity

    public Procedure getEntity()

  Deprecated. since 1.2 use getProcedure() instead.

  Returns the procedure that holds this parameter.

### getMaxLength

    public int getMaxLength()

### getPrecision

    public int getPrecision()

### getType

    public int getType()

### isInParameter

    public boolean isInParameter()

  Returns:
    `true` if this is IN or INOUT parameter.

### isOutParam

    public boolean isOutParam()

  Returns:
    `true` if this is OUT or INOUT parameter.

### setDirection

    public void setDirection(int direction)

  Sets the direction of this parameter. Acceptable values of direction are defined as int constants in ProcedureParam class. If an attempt is made to set an invalid attribute's direction, an IllegalArgumentException is thrown by this method.

### setMaxLength

    public void setMaxLength(int i)

### setPrecision

    public void setPrecision(int i)

### setType

    public void setType(int i)

### getProcedure

    public Procedure getProcedure()

  Returns the procedure that holds this parameter.

### setProcedure

    public void setProcedure(Procedure procedure)

  Sets the procedure that holds this parameter.

Overview | Package | Class | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Copyright © 2001-2006 Apache.org All Rights Reserved.