parameter
Applies when
type in (PLSQL_PACKAGE)type in (PLSQL_PROCEDURE_FUNCTION)| Property | Type | Required | Default Value | Details |
|---|---|---|---|---|
type | enum | Yes | parameter | data type=string; lov=STATICValid values: parameter functionResult |
name | string | Yes | p_ | data type=string; maxLen=255Applies when type = parameterEnter the name of a parameter declared in the selected procedure or function. |
parameter
| Property | Type | Required | Default Value | Details |
|---|---|---|---|---|
direction | enum | Yes | in | data type=string; lov=STATICValid values: in out inOutApplies when type = parameter |
dataType | enum | Yes | varchar2 | data type=string; lov=STATICValid values: varchar2 clob number plsqlInteger boolean date timestamp timestampWithLocalTimeZone timestampWithTimeZone intervalYearToMonth intervalDayToSecond blob char rowid custom |
dataTypeName | string | Yes | data type=string; maxLen=32767Applies when dataType = custom | |
hasDefault | boolean | Yes | false | data type=booleanApplies when type = parameter and direction = in |
ignoreOutput | boolean | Yes | false | data type=booleanApplies when type = parameter and direction in (inOut)type = parameter and direction in (out) |
parameter {
direction: in
dataType: varchar2
dataTypeName: value
hasDefault: false
ignoreOutput: false
}value
| Property | Type | Required | Default Value | Details |
|---|---|---|---|---|
type | enum | Yes | data type=string; lov=STATICValid values: staticValue item sqlQuery expression functionBody preference apiDefault nullApplies when type = parameter and direction in (in) and direction in (inOut) and ignoreOutput = truetype = parameter and direction in (in) and direction in (out) and ignoreOutput = truetype = parameter and direction in (inOut) and ignoreOutput = truetype = parameter and direction in (inOut) and direction in (out) and ignoreOutput = true | |
staticValue | multiline string | Yes | data type=multiline string; maxLen=4000Applies when type = parameter and direction in (in) and direction in (inOut) and ignoreOutput = true and type = staticValuetype = parameter and direction in (in) and direction in (out) and ignoreOutput = true and type = staticValuetype = parameter and direction in (inOut) and ignoreOutput = true and type = staticValuetype = parameter and direction in (inOut) and direction in (out) and ignoreOutput = true and type = staticValue | |
staticValue | enum | Yes | data type=string; lov=STATICValid values: true falseApplies when type = parameter and direction in (in) and direction in (inOut) and ignoreOutput = true and type = staticValue and dataType = booleantype = parameter and direction in (in) and direction in (out) and ignoreOutput = true and type = staticValue and dataType = booleantype = parameter and direction in (inOut) and ignoreOutput = true and type = staticValue and dataType = booleantype = parameter and direction in (inOut) and direction in (out) and ignoreOutput = true and type = staticValue and dataType = boolean | |
sqlQuery | multiline string | Yes | data type=multiline string; maxLen=4000Applies when type = parameter and direction in (in) and direction in (inOut) and ignoreOutput = true and type = sqlQuerytype = parameter and direction in (in) and direction in (out) and ignoreOutput = true and type = sqlQuerytype = parameter and direction in (inOut) and ignoreOutput = true and type = sqlQuerytype = parameter and direction in (inOut) and direction in (out) and ignoreOutput = true and type = sqlQuery | |
item | string | Yes | data type=string; maxLen=255; textCase=UPPERApplies when type = parameter and direction in (in) and direction in (inOut) and ignoreOutput = true and type = itemtype = parameter and direction in (in) and direction in (out) and ignoreOutput = true and type = itemtype = parameter and direction in (inOut) and ignoreOutput = true and type = itemtype = parameter and direction in (inOut) and direction in (out) and ignoreOutput = true and type = itemtype = parameter and direction in (inOut) and ignoreOutput = falsetype = parameter and direction in (out) and ignoreOutput = false | |
language | enum | Yes | plsql | data type=string; lov=STATICValid values: sql plsql javaScript-mleApplies when type = parameter and direction in (in) and direction in (inOut) and ignoreOutput = true and type = expressiontype = parameter and direction in (in) and direction in (out) and ignoreOutput = true and type = expressiontype = parameter and direction in (inOut) and ignoreOutput = true and type = expressiontype = parameter and direction in (inOut) and direction in (out) and ignoreOutput = true and type = expression |
sqlExpression | multiline string | Yes | data type=multiline string; maxLen=4000Applies when type = parameter and direction in (in) and direction in (inOut) and ignoreOutput = true and type = expression and language = sqltype = parameter and direction in (in) and direction in (out) and ignoreOutput = true and type = expression and language = sqltype = parameter and direction in (inOut) and ignoreOutput = true and type = expression and language = sqltype = parameter and direction in (inOut) and direction in (out) and ignoreOutput = true and type = expression and language = sql | |
plsqlExpression | multiline string | Yes | data type=multiline string; maxLen=4000Applies when type = parameter and direction in (in) and direction in (inOut) and ignoreOutput = true and type = expression and language = plsqltype = parameter and direction in (in) and direction in (out) and ignoreOutput = true and type = expression and language = plsqltype = parameter and direction in (inOut) and ignoreOutput = true and type = expression and language = plsqltype = parameter and direction in (inOut) and direction in (out) and ignoreOutput = true and type = expression and language = plsql | |
javaScriptExpression | multiline string | Yes | data type=multiline string; maxLen=4000Applies when type = parameter and direction in (in) and direction in (inOut) and ignoreOutput = true and type = expression and language = javaScript-mletype = parameter and direction in (in) and direction in (out) and ignoreOutput = true and type = expression and language = javaScript-mletype = parameter and direction in (inOut) and ignoreOutput = true and type = expression and language = javaScript-mletype = parameter and direction in (inOut) and direction in (out) and ignoreOutput = true and type = expression and language = javaScript-mle | |
language | enum | Yes | plsql | data type=string; lov=STATICValid values: plsql javaScript-mleApplies when type = parameter and direction in (in) and direction in (inOut) and ignoreOutput = true and type = functionBodytype = parameter and direction in (in) and direction in (out) and ignoreOutput = true and type = functionBodytype = parameter and direction in (inOut) and ignoreOutput = true and type = functionBodytype = parameter and direction in (inOut) and direction in (out) and ignoreOutput = true and type = functionBody |
plsqlFunctionBody | multiline string | Yes | data type=multiline string; maxLen=4000Applies when type = parameter and direction in (in) and direction in (inOut) and ignoreOutput = true and type = functionBody and language = plsqltype = parameter and direction in (in) and direction in (out) and ignoreOutput = true and type = functionBody and language = plsqltype = parameter and direction in (inOut) and ignoreOutput = true and type = functionBody and language = plsqltype = parameter and direction in (inOut) and direction in (out) and ignoreOutput = true and type = functionBody and language = plsql | |
javaScriptFunctionBody | multiline string | Yes | data type=multiline string; maxLen=4000Applies when type = parameter and direction in (in) and direction in (inOut) and ignoreOutput = true and type = functionBody and language = javaScript-mletype = parameter and direction in (in) and direction in (out) and ignoreOutput = true and type = functionBody and language = javaScript-mletype = parameter and direction in (inOut) and ignoreOutput = true and type = functionBody and language = javaScript-mletype = parameter and direction in (inOut) and direction in (out) and ignoreOutput = true and type = functionBody and language = javaScript-mle | |
plsqlExpression | multiline string | Yes | data type=multiline string; maxLen=4000Applies when type = parameter and direction in (in) and direction in (inOut) and ignoreOutput = true and type = expression and dataType = customtype = parameter and direction in (in) and direction in (out) and ignoreOutput = true and type = expression and dataType = customtype = parameter and direction in (inOut) and ignoreOutput = true and type = expression and dataType = customtype = parameter and direction in (inOut) and direction in (out) and ignoreOutput = true and type = expression and dataType = custom | |
plsqlFunctionBody | multiline string | Yes | data type=multiline string; maxLen=4000Applies when type = parameter and direction in (in) and direction in (inOut) and ignoreOutput = true and type = functionBody and dataType = customtype = parameter and direction in (in) and direction in (out) and ignoreOutput = true and type = functionBody and dataType = customtype = parameter and direction in (inOut) and ignoreOutput = true and type = functionBody and dataType = customtype = parameter and direction in (inOut) and direction in (out) and ignoreOutput = true and type = functionBody and dataType = custom | |
preference | string | Yes | data type=string; maxLen=255; textCase=UPPERApplies when type = parameter and direction in (in) and direction in (inOut) and ignoreOutput = true and type = preferencetype = parameter and direction in (in) and direction in (out) and ignoreOutput = true and type = preferencetype = parameter and direction in (inOut) and ignoreOutput = true and type = preferencetype = parameter and direction in (inOut) and direction in (out) and ignoreOutput = true and type = preference | |
formatMask | string | No | data type=string; maxLen=255Applies when dataType in (number) and type = parameter and direction in (in) and direction in (inOut) and ignoreOutput = true and type in (staticValue)dataType in (number) and type = parameter and direction in (in) and direction in (inOut) and ignoreOutput = true and type in (item)dataType in (number) and type = parameter and direction in (in) and direction in (inOut) and ignoreOutput = true and type in (preference)dataType in (number) and type = parameter and direction in (in) and direction in (out) and ignoreOutput = true and type in (staticValue)dataType in (number) and type = parameter and direction in (in) and direction in (out) and ignoreOutput = true and type in (item)dataType in (number) and type = parameter and direction in (in) and direction in (out) and ignoreOutput = true and type in (preference)dataType in (number) and type = parameter and direction in (inOut) and ignoreOutput = true and type in (staticValue)dataType in (number) and type = parameter and direction in (inOut) and ignoreOutput = true and type in (item)dataType in (number) and type = parameter and direction in (inOut) and ignoreOutput = true and type in (preference)dataType in (number) and type = parameter and direction in (inOut) and direction in (out) and ignoreOutput = true and type in (staticValue)dataType in (number) and type = parameter and direction in (inOut) and direction in (out) and ignoreOutput = true and type in (item)dataType in (number) and type = parameter and direction in (inOut) and direction in (out) and ignoreOutput = true and type in (preference)dataType in (number) and type = parameter and direction in (inOut) and ignoreOutput = falsedataType in (number) and type = parameter and direction in (inOut) and direction in (out) and ignoreOutput = falsedataType in (number) and type = parameter and direction in (out) and direction in (inOut) and ignoreOutput = falsedataType in (number) and type = parameter and direction in (out) and ignoreOutput = falsedataType in (number) and type = functionResultdataType in (date) and type = parameter and direction in (in) and direction in (inOut) and ignoreOutput = true and type in (staticValue)dataType in (date) and type = parameter and direction in (in) and direction in (inOut) and ignoreOutput = true and type in (item)dataType in (date) and type = parameter and direction in (in) and direction in (inOut) and ignoreOutput = true and type in (preference)dataType in (date) and type = parameter and direction in (in) and direction in (out) and ignoreOutput = true and type in (staticValue)dataType in (date) and type = parameter and direction in (in) and direction in (out) and ignoreOutput = true and type in (item)dataType in (date) and type = parameter and direction in (in) and direction in (out) and ignoreOutput = true and type in (preference)dataType in (date) and type = parameter and direction in (inOut) and ignoreOutput = true and type in (staticValue)dataType in (date) and type = parameter and direction in (inOut) and ignoreOutput = true and type in (item)dataType in (date) and type = parameter and direction in (inOut) and ignoreOutput = true and type in (preference)dataType in (date) and type = parameter and direction in (inOut) and direction in (out) and ignoreOutput = true and type in (staticValue)dataType in (date) and type = parameter and direction in (inOut) and direction in (out) and ignoreOutput = true and type in (item)dataType in (date) and type = parameter and direction in (inOut) and direction in (out) and ignoreOutput = true and type in (preference)dataType in (date) and type = parameter and direction in (inOut) and ignoreOutput = falsedataType in (date) and type = parameter and direction in (inOut) and direction in (out) and ignoreOutput = falsedataType in (date) and type = parameter and direction in (out) and direction in (inOut) and ignoreOutput = falsedataType in (date) and type = parameter and direction in (out) and ignoreOutput = falsedataType in (date) and type = functionResultdataType in (timestamp) and type = parameter and direction in (in) and direction in (inOut) and ignoreOutput = true and type in (staticValue)dataType in (timestamp) and type = parameter and direction in (in) and direction in (inOut) and ignoreOutput = true and type in (item)dataType in (timestamp) and type = parameter and direction in (in) and direction in (inOut) and ignoreOutput = true and type in (preference)dataType in (timestamp) and type = parameter and direction in (in) and direction in (out) and ignoreOutput = true and type in (staticValue)dataType in (timestamp) and type = parameter and direction in (in) and direction in (out) and ignoreOutput = true and type in (item)dataType in (timestamp) and type = parameter and direction in (in) and direction in (out) and ignoreOutput = true and type in (preference)dataType in (timestamp) and type = parameter and direction in (inOut) and ignoreOutput = true and type in (staticValue)dataType in (timestamp) and type = parameter and direction in (inOut) and ignoreOutput = true and type in (item)dataType in (timestamp) and type = parameter and direction in (inOut) and ignoreOutput = true and type in (preference)dataType in (timestamp) and type = parameter and direction in (inOut) and direction in (out) and ignoreOutput = true and type in (staticValue)dataType in (timestamp) and type = parameter and direction in (inOut) and direction in (out) and ignoreOutput = true and type in (item)dataType in (timestamp) and type = parameter and direction in (inOut) and direction in (out) and ignoreOutput = true and type in (preference)dataType in (timestamp) and type = parameter and direction in (inOut) and ignoreOutput = falsedataType in (timestamp) and type = parameter and direction in (inOut) and direction in (out) and ignoreOutput = falsedataType in (timestamp) and type = parameter and direction in (out) and direction in (inOut) and ignoreOutput = falsedataType in (timestamp) and type = parameter and direction in (out) and ignoreOutput = falsedataType in (timestamp) and type = functionResultdataType in (timestampWithTimeZone) and type = parameter and direction in (in) and direction in (inOut) and ignoreOutput = true and type in (staticValue)dataType in (timestampWithTimeZone) and type = parameter and direction in (in) and direction in (inOut) and ignoreOutput = true and type in (item)dataType in (timestampWithTimeZone) and type = parameter and direction in (in) and direction in (inOut) and ignoreOutput = true and type in (preference)dataType in (timestampWithTimeZone) and type = parameter and direction in (in) and direction in (out) and ignoreOutput = true and type in (staticValue)dataType in (timestampWithTimeZone) and type = parameter and direction in (in) and direction in (out) and ignoreOutput = true and type in (item)dataType in (timestampWithTimeZone) and type = parameter and direction in (in) and direction in (out) and ignoreOutput = true and type in (preference)dataType in (timestampWithTimeZone) and type = parameter and direction in (inOut) and ignoreOutput = true and type in (staticValue)dataType in (timestampWithTimeZone) and type = parameter and direction in (inOut) and ignoreOutput = true and type in (item)dataType in (timestampWithTimeZone) and type = parameter and direction in (inOut) and ignoreOutput = true and type in (preference)dataType in (timestampWithTimeZone) and type = parameter and direction in (inOut) and direction in (out) and ignoreOutput = true and type in (staticValue)dataType in (timestampWithTimeZone) and type = parameter and direction in (inOut) and direction in (out) and ignoreOutput = true and type in (item)dataType in (timestampWithTimeZone) and type = parameter and direction in (inOut) and direction in (out) and ignoreOutput = true and type in (preference)dataType in (timestampWithTimeZone) and type = parameter and direction in (inOut) and ignoreOutput = falsedataType in (timestampWithTimeZone) and type = parameter and direction in (inOut) and direction in (out) and ignoreOutput = falsedataType in (timestampWithTimeZone) and type = parameter and direction in (out) and direction in (inOut) and ignoreOutput = falsedataType in (timestampWithTimeZone) and type = parameter and direction in (out) and ignoreOutput = falsedataType in (timestampWithTimeZone) and type = functionResultdataType in (timestampWithLocalTimeZone) and type = parameter and direction in (in) and direction in (inOut) and ignoreOutput = true and type in (staticValue)dataType in (timestampWithLocalTimeZone) and type = parameter and direction in (in) and direction in (inOut) and ignoreOutput = true and type in (item)dataType in (timestampWithLocalTimeZone) and type = parameter and direction in (in) and direction in (inOut) and ignoreOutput = true and type in (preference)dataType in (timestampWithLocalTimeZone) and type = parameter and direction in (in) and direction in (out) and ignoreOutput = true and type in (staticValue)dataType in (timestampWithLocalTimeZone) and type = parameter and direction in (in) and direction in (out) and ignoreOutput = true and type in (item)dataType in (timestampWithLocalTimeZone) and type = parameter and direction in (in) and direction in (out) and ignoreOutput = true and type in (preference)dataType in (timestampWithLocalTimeZone) and type = parameter and direction in (inOut) and ignoreOutput = true and type in (staticValue)dataType in (timestampWithLocalTimeZone) and type = parameter and direction in (inOut) and ignoreOutput = true and type in (item)dataType in (timestampWithLocalTimeZone) and type = parameter and direction in (inOut) and ignoreOutput = true and type in (preference)dataType in (timestampWithLocalTimeZone) and type = parameter and direction in (inOut) and direction in (out) and ignoreOutput = true and type in (staticValue)dataType in (timestampWithLocalTimeZone) and type = parameter and direction in (inOut) and direction in (out) and ignoreOutput = true and type in (item)dataType in (timestampWithLocalTimeZone) and type = parameter and direction in (inOut) and direction in (out) and ignoreOutput = true and type in (preference)dataType in (timestampWithLocalTimeZone) and type = parameter and direction in (inOut) and ignoreOutput = falsedataType in (timestampWithLocalTimeZone) and type = parameter and direction in (inOut) and direction in (out) and ignoreOutput = falsedataType in (timestampWithLocalTimeZone) and type = parameter and direction in (out) and direction in (inOut) and ignoreOutput = falsedataType in (timestampWithLocalTimeZone) and type = parameter and direction in (out) and ignoreOutput = falsedataType in (timestampWithLocalTimeZone) and type = functionResult | |
trueValue | string | No | data type=string; maxLen=10Applies when dataType = boolean and type = parameter and direction in (in) and direction in (inOut) and ignoreOutput = true and type in (item)dataType = boolean and type = parameter and direction in (in) and direction in (inOut) and ignoreOutput = true and type in (preference)dataType = boolean and type = parameter and direction in (in) and direction in (out) and ignoreOutput = true and type in (item)dataType = boolean and type = parameter and direction in (in) and direction in (out) and ignoreOutput = true and type in (preference)dataType = boolean and type = parameter and direction in (inOut) and ignoreOutput = true and type in (item)dataType = boolean and type = parameter and direction in (inOut) and ignoreOutput = true and type in (preference)dataType = boolean and type = parameter and direction in (inOut) and direction in (out) and ignoreOutput = true and type in (item)dataType = boolean and type = parameter and direction in (inOut) and direction in (out) and ignoreOutput = true and type in (preference)dataType = boolean and type = parameter and direction in (inOut) and ignoreOutput = falsedataType = boolean and type = parameter and direction in (inOut) and direction in (out) and ignoreOutput = falsedataType = boolean and type = parameter and direction in (out) and direction in (inOut) and ignoreOutput = falsedataType = boolean and type = parameter and direction in (out) and ignoreOutput = falsedataType = boolean and type = functionResult | |
falseValue | string | No | data type=string; maxLen=10Applies when dataType = boolean and type = parameter and direction in (in) and direction in (inOut) and ignoreOutput = true and type in (item)dataType = boolean and type = parameter and direction in (in) and direction in (inOut) and ignoreOutput = true and type in (preference)dataType = boolean and type = parameter and direction in (in) and direction in (out) and ignoreOutput = true and type in (item)dataType = boolean and type = parameter and direction in (in) and direction in (out) and ignoreOutput = true and type in (preference)dataType = boolean and type = parameter and direction in (inOut) and ignoreOutput = true and type in (item)dataType = boolean and type = parameter and direction in (inOut) and ignoreOutput = true and type in (preference)dataType = boolean and type = parameter and direction in (inOut) and direction in (out) and ignoreOutput = true and type in (item)dataType = boolean and type = parameter and direction in (inOut) and direction in (out) and ignoreOutput = true and type in (preference)dataType = boolean and type = parameter and direction in (inOut) and ignoreOutput = falsedataType = boolean and type = parameter and direction in (inOut) and direction in (out) and ignoreOutput = falsedataType = boolean and type = parameter and direction in (out) and direction in (inOut) and ignoreOutput = falsedataType = boolean and type = parameter and direction in (out) and ignoreOutput = falsedataType = boolean and type = functionResult |
value {
type: staticValue
staticValue: ```
value
```
sqlQuery: ```sql
value
```
item: value
language: sql
sqlExpression: ```sql
value
```
plsqlExpression: ```plsql
value
```
javaScriptExpression: ```javascript-mle
value
```
plsqlFunctionBody: ```plsql
value
```
javaScriptFunctionBody: ```javascript-mle
value
```
preference: value
formatMask: value
trueValue: value
falseValue: value
}advanced
| Property | Type | Required | Default Value | Details |
|---|---|---|---|---|
displaySequence | integer | Yes | data type=integer; maxLen=32767 |
advanced {
displaySequence: 42
}comments
| Property | Type | Required | Default Value | Details |
|---|---|---|---|---|
comments | multiline string | No | data type=multiline string; maxLen=4000 |
comments {
comments: ```
value
```
}APEXlang Example
parameter sample (
type: parameter
name: value
parameter {
direction: in
dataType: varchar2
dataTypeName: value
hasDefault: false
ignoreOutput: false
}
value {
type: staticValue
staticValue: ```
value
```
sqlQuery: ```sql
value
```
item: value
language: sql
sqlExpression: ```sql
value
```
plsqlExpression: ```plsql
value
```
javaScriptExpression: ```javascript-mle
value
```
plsqlFunctionBody: ```plsql
value
```
javaScriptFunctionBody: ```javascript-mle
value
```
preference: value
formatMask: value
trueValue: value
falseValue: value
}
advanced {
displaySequence: 42
}
comments {
comments: ```
value
```
}
)