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

## org.eclipse.birt.data.engine.api
Interface IBaseParameterMetaData

All Known Subinterfaces:
  IParameterMetaData

    public interface IBaseParameterMetaData

Method Summary
`int` | `getDataType()` Returns the data type of this parameter.
`java.lang.String` | `getName()` Returns the name of this parameter.
`int` | `getPosition()` Returns the 1-based parameter position of this parameter, as defined by the underlying data provider.
`java.lang.Boolean` | `isNullable()` Returns whether a null value is allowed for this parameter.
`java.lang.Boolean` | `isOptional()` Returns whether this parameter is optional.

Method Detail

### getName

    java.lang.String getName()

  Returns the name of this parameter.

  Returns:
    the parameter name of this parameter, or null if the name is non-specified or unknown.

### getPosition

    int getPosition()

  Returns the 1-based parameter position of this parameter, as defined by the underlying data provider. Not all data source parameters are defined with a position value.

  Returns:
    the 1-based parameter position of this parameter, or -1 if the position is non-specified or unknown.

### getDataType

    int getDataType()
                    throws org.eclipse.birt.core.exception.BirtException

  Returns the data type of this parameter.

  Returns:
    The data type of this parameter, as an integer defined in `org.eclipse.birt.core.data.DataType`.
  Throws:
    `DataException`
    `org.eclipse.birt.core.exception.BirtException`

### isOptional

    java.lang.Boolean isOptional()

  Returns whether this parameter is optional.

  Returns:
    true if this parameter is optional, false if this parameter is required, null if unknown.

### isNullable

    java.lang.Boolean isNullable()

  Returns whether a null value is allowed for this parameter.

  Returns:
    true if null is allowed for this parameter, false if null is not allowed, or null if its nullability is not specified or unknown.

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

Copyright © 2008 Actuate Corp. All rights reserved.