Class Parameter

A Parameter object represents a parameter in an ABL procedure / function / method, it's properties and information about it.

Hierarchy

Parameter

Implements

IParameter

Index

Constructors

constructor

Accessors

Methods

Constructors

constructor

new Parameter(direction: Direction, type?: DataType, value?: any, json?: boolean, sql?: boolean, schema?: Schema): Parameter

Creates a parameter for a Progress procedure.

Parameters
- direction: Direction
  
  The direction of the parameter (INPUT / OUTPUT / INPUT-OUTPUT)
- Optional type: DataType
  
  The data type of the parameter
- Optional value: any
  
  The value of the parameter
- Optional json: boolean
  
  Specifies whether the value of the parameter is a JSON object or not
- Optional sql: boolean
  
  Specifies whether the value of the parameter is an SQL object or not
- Optional schema: Schema
  
  The schema for the parameter, if it's datatype is TABLE / DATASET and it's direction is INPUT / INPUT-OUTPUT
Returns Parameter

Accessors

direction

get direction(): Direction

Returns the direction of the parameter.

Returns Direction

json

get json(): boolean

Returns whether the parameter's value is a JSON object or not.

Returns boolean

schema

get schema(): Schema

Returns the schema of the parameter.

Returns Schema

sql

get sql(): boolean

Returns whether the parameter's value is an SQL object or not.

Returns boolean

type

get type(): DataType

Returns the datatype of the parameter.

Returns DataType

value

get value(): any

Returns the value of the parameter.

Returns any

Methods

build

build(): IParameter

Transforms the current Parameter object into a IParameter object.

Returns IParameter

Static check

check(prm: IParameter): void

Checks if a parameter fulfills some conditions so that it can be considered valid

Parameters
- prm: IParameter
Returns void

Static inout

inout(dtype: DataType, value?: any, schema?: Schema, json?: boolean, sql?: boolean): Parameter

Creates an INPUT-OUTPUT parameter.

Parameters
- dtype: DataType
  
  The datatype of the parameter
- Optional value: any
  
  The value of the parameter
- Optional schema: Schema
  
  The schema of the parameter, if it's datatype is TABLE / DATASET and it's direction is INPUT / INPUT-OUTPUT
- Optional json: boolean
  
  Specifies whether the value of the parameter is a JSON object or not
- Optional sql: boolean
  
  Specifies whether the value of the parameter is an SQL object or not
Returns Parameter

Static input

input(value: any, dtype?: DataType, schema?: Schema): Parameter

Creates an INPUT parameter.

Parameters
- value: any
  
  The value of the parameter
- Optional dtype: DataType
  
  The data type of the parameter
- Optional schema: Schema
  
  The schema of the parameter, if it's datatype is TABLE / DATASET and it's direction is INPUT / INPUT-OUTPUT
Returns Parameter

Static output

output(dtype: DataType, json?: boolean, sql?: boolean): Parameter

Creates an OUTPUT parameter.

Parameters
- dtype: DataType
  
  The datatype of the parameter
- Optional json: boolean
  
  Specifies whether the value of the parameter is a JSON object or not
- Optional sql: boolean
  
  Specifies whether the value of the parameter is a JSON object or not
Returns Parameter

Static parse

parse(parameter: Object): Parameter

Builds a Progress procedure parameter out of a plain JSON object

Parameters
- parameter: Object
Returns Parameter

Static xmlData

xmlData(data: any, schema: ITableSchema): string

Builds an XML Document out of a database table and a data object, and returns it as a string that can be further used to populate a Progress table in the database

Parameters
- data: any
  
  The data object / Array with objects
- schema: ITableSchema
  
  The Table schema
Returns string

Static xmlSchema

xmlSchema(schema: ITableSchema): string

Builds an XML Schema out of a database table, and returns it as a string that can be further used to build a Progress table in the database

Parameters
- schema: ITableSchema
Returns string