Ingrid-Message

Index

Nice to know

All Ingrid Message functions

Name Function header Example Result Description Errorhandling Alias
addControlValue func(msg Msg, k string, v string) Msg [[ $msg := addControlValue $msg "keyfield1" "value field1" ]] $msg.control[keyfield1] = “value field1” adds a key value pair to the ingrid message control part.
addControlValueOnResult func(r Result, k, v string) Result [[ $result := addControlValueOnResult $result "keyfield1" "value field1" ]] $result.control[keyfield1] = “value field1” adds a key value pair to a result control part.
addControlValues func(msg Msg, k string, v []string) Msg { addValues(msg.Control, k, v); return msg } [[ $msg := addControlValues $msg "keyfield1" ( toStrings ( list "value field1" ) ) ]] $msg.control[keyfield1] = “value field1” adds a key value pair with multiple values to an ingrid message control part.
addControlValuesOnResult func(r Result, k string, v []string) Result [[ $result := addControlValuesOnResult $result "keyfield1" ( toStrings ( list "value1" "value2" ) ) ]] $result.control[keyfield1] = “value1 value2” adds a key value pair with multiple values to a result control part.
addDataValue func(msg Msg, varname string, value string) Msg [[ $msg := addDataValue $msg "keyfield1" "value field1" ]] $msg.data[keyfield1] = “value field1” adds a key value pair to the ingrid message data part.
addDataValueOnResult func(r Result, k, v string) Result [[ $result := addDataValueOnResult $result "keyfield1" "value field1" ]] $result.data[keyfield1] = “value field1” adds a key value pair to a result control part.
addDataValues func(msg Msg, varname string, values []string) Msg [[ $msg := addDataValues $msg "keyfield1" ( toStrings ( list "value field1" ) ) ]] $msg.data[keyfield1] = “value field1” adds a key value pair with multiple values to an ingrid message data part.
addDataValuesOnResult func(r Result, k string, v []string) Result [[ $result := addDataValuesOnResult $result "keyfield1" ( toStrings ( list "value1" "value2" ) ) ]] $result.data[keyfield1] = “value1 value2” adds a key value pair with multiple values to a result data part.
addResultControlValue func(msg Msg, varname string, values []string) Msg [[ $msg := addResultControlValue $msg "keyfield1" "value field1" ]] $msg.result.control[keyfield1] = “value field1” adds a key value pair to an ingrid message result control part.
addResultControlValues func(msg Msg, varname string, values []string) Msg [[ $msg := addResultControlValues $msg "keyfield1" ( toStrings ( list "value1" "value2" ) ) ]] $msg.result.control[keyfield1] = “value1 value2” adds a key value pair with multiple values to an ingrid message result control part.
addResultDataValue func(msg Msg, varname string, value string) Msg [[ $msg := addResultDataValue $msg "keyfield1" "value field1" ]] $msg.result.data[keyfield1] = “value field1” adds a key value pair to an ingrid message result data part.
addResultDataValues func(msg Msg, varname string, values []string) Msg [[ $msg := addResultDataValues $msg "keyfield1" ( toStrings ( list "value1" "value2" ) ) ]] $msg.result.data[keyfield1] = “value1 value2” adds a key value pair with multiple values to an ingrid message result data part.
addValue func(in interface{}, name string, value string) Data [[ $msg := addValue $msg "keyfield1" "value field1" ]] $msg.data[keyfield1] = “value field1” adds a key value pair in a specified ingrid message part via interface.
addValues func(in interface{}, name string, values []string) Data [[ $msg := addValues $msg "keyfield1" ( toStrings ( list "value1" "value2" ) ) ]] $msg.data[keyfield1] = “value1 value2” adds a key value pair with multiple values in a specified ingrid message part via interface.
clearControlValue func(msg Msg, varname string) Msg [[ $msg := clearControlValues $msg "keyfield1" ]] $msg.control[keyfield1] = “” clears all values in a specific key in an ingrid message control part.
clearControlValueOnResult func(r Result, name string) Result [[ $result := clearControlValuesOnResult $result "keyfield1" ]] $msg.result.control[keyfield1] = “” clears all values in a specific key in a result control part.
clearControlValues func(msg Msg, varname string) Msg [[ $msg := clearControlValues $msg "keyfield1" ]] $msg.control[keyfield1] = “” clears all values in a specific key in an ingrid message control part.
clearControlValuesOnResult func(r Result, name string) Result [[ $result := clearControlValuesOnResult $result "keyfield1" ]] $msg.result.control[keyfield1] = “” clears all values in a specific key in a result control part.
clearDataValue func(msg Msg, varname string) Msg [[ $msg := clearDataValue $msg "keyfield1" ]] $msg.data[keyfield1] = “” clears all values in a specific key in an ingrid message data part.
clearDataValueOnResult func(r Result, name string) Result [[ $result := clearDataValueOnResult $result "keyfield1" ]] $msg.result.data[keyfield1] = “” clears all values in a specific key in a result data part.
clearDataValues func(msg Msg, varname string) Msg [[ $msg := clearDataValues $msg "keyfield1" ]] $msg.data[keyfield1] = “” clears all values in a specific key in an ingrid message data part.
clearDataValuesOnResult func(r Result, name string) Result [[ $result := clearDataValuesOnResult $result "keyfield1" ]] $msg.result.data[keyfield1] = “” clears all values in a specific key in a result data part.
clearResultControlValue func(msg Msg, varname string) Msg [[ $msg := clearResultControlValue $msg "keyfield1" ]] $msg.result.control[keyfield1] = “” clears all values in a specific key in an ingrid message result control part.
clearResultControlValues func(msg Msg, varname string) Msg [[ $msg := clearResultControlValues $msg "keyfield1" ]] $msg.result.control[keyfield1] = “” clears all values in a specific key in an ingrid message result control part.
clearResultDataValue func(msg Msg, varname string) Msg [[ $msg := clearResultDataValues $msg "keyfield1" ]] $msg.result.data[keyfield1] = “” clears all values in a specific key in an ingrid message result data part.
clearResultDataValues func(msg Msg, varname string) Msg [[ $msg := clearResultDataValues $msg "keyfield1" ]] $msg.result.data[keyfield1] = “” clears all values in a specific key in an ingrid message result data part.
clearValue func(in interface{}, name string) (data Data, err error) [[ $msg := clearValue $msg "keyfield1" ]] $msg.data[keyfield1] = “” clears a key value pair with multiple values in a specified ingrid message part via interface. X
clearValueOnResult func(r Result, name string) Result [[ $result := clearValueOnResult $result "keyfield1" ]] $msg.result.data[keyfield1] = “” clears all values in a specific key in a result data part.
clearValues func(in interface{}, name string) (data Data, err error) [[ $msg := clearValues $msg "keyfield1" ]] $msg.data[keyfield1] = “” clears a key value pair with multiple values in a specified ingrid message part via interface. X
clearValuesOnResult func(r Result, name string) Result [[ $result := clearValuesOnResult $result "keyfield1" ]] $msg.result.data[keyfield1] = “” clears all values in a specific key in a result data part.
getClass func [[ $result := ]]
getCode func [[ $result := ]]
getCodeOnResult func [[ $result := ]]
getControl func [[ $result := ]]
getControlKeys func [[ $result := ]]
getControlKeysOnResult func [[ $result := ]]
getControlOnResult func [[ $result := ]]
getControls func [[ $result := ]]
getControlsOnResult func [[ $result := ]]
getControlValue func [[ $result := ]]
getControlValueOnResult func [[ $result := ]]
getControlValues func [[ $result := ]]
getControlValuesOnResult func [[ $result := ]]
getCurrentRequest func() Msg [[ $result := ]]
getData func [[ $result := ]]
getDataKeys func [[ $result := ]]
getDataKeysOnResult func [[ $result := ]]
getDataOnResult func [[ $result := ]]
getDataValue func [[ $result := ]]
getDataValueOnResult func [[ $result := ]]
getDataValues func [[ $result := ]]
getDataValuesOnResult func [[ $result := ]]
getID func(msg Msg) string [[ $result := ]]
getKeys func [[ $result := ]]
getKeysOnResult func [[ $result := ]]
getList
// TODO Input Postman mit “List” “error”:
“message=Unmarshal type error:
expected=[]msg.Data, got=object,
field=List3”		 func [[ $result := ]]
getListOnResult func [[ $result := ]]
getMessage func [[ $result := ]]
getMessageOnResult func [[ $result := ]]
getMsg func() Msg [[ $result := ]]
getMsgOnResult func [[ $result := ]]
getOperation func [[ $result := ]]
getRequest func() IngridMsg [[ $result := ]]
getRequestID func(msg IngridMsg) string [[ $result := ]]
getResult func [[ $result := ]]
getResultCode func [[ $result := ]]
getResultControl func [[ $result := ]]
getResultControlKeys func [[ $result := ]]
getResultControls func [[ $result := ]]
getResultControlValue func [[ $result := ]]
getResultControlValues func [[ $result := ]]
getResultData func [[ $result := ]]
getResultDataKeys func [[ $result := ]]
getResultDataValue func [[ $result := ]]
getResultDataValues func [[ $result := ]]
getResultKeys func [[ $result := ]]
getResultList func [[ $result := ]]
getResultMessage func [[ $result := ]]
getResultMsg func [[ $result := ]]
getValue func [[ $result := ]]
getValueOnResult func [[ $result := ]]
getValues func [[ $result := ]]
getValuesOnResult func [[ $result := ]]
hasControlKey func [[ $result := ]]
hasControlKeyOnResult func [[ $result := ]]
hasControlKeys func [[ $result := ]]
hasControlKeysOnResult func [[ $result := ]]
hasControlValue func [[ $result := ]]
hasControlValueOnResult func [[ $result := ]]
hasControlValues func [[ $result := ]]
hasControlValuesOnResult func [[ $result := ]]
hasDataKey func [[ $result := ]]
hasDataKeyOnResult func [[ $result := ]]
hasDataKeys func [[ $result := ]]
hasDataKeysOnResult func [[ $result := ]]
hasDataValue func [[ $result := ]]
hasDataValueOnResult func [[ $result := ]]
hasDataValues func [[ $result := ]]
hasDataValuesOnResult func [[ $result := ]]
hasKey func [[ $result := ]]
hasKeyOnResult func [[ $result := ]]
hasKeys func [[ $result := ]]
hasKeysOnResult func [[ $result := ]]
hasList func [[ $result := ]]
hasListOnResult func [[ $result := ]]
hasResultControlKey func [[ $result := ]]
hasResultControlKeys func [[ $result := ]]
hasResultControlValue func [[ $result := ]]
hasResultControlValues func [[ $result := ]]
hasResultDataKey func [[ $result := ]]
hasResultDataKeys func [[ $result := ]]
hasResultDataValue func [[ $result := ]]
hasResultDataValues func [[ $result := ]]
hasResultList func [[ $result := ]]
hasValue func [[ $result := ]]
hasValueOnResult func [[ $result := ]]
hasValues func [[ $result := ]]
hasValuesOnResult func [[ $result := ]]
newControl alias newData func newData() Data [[ $ctrl1 := newData ]]<br>[[ $ctrl1 := setValue $ctrl1 "ctrl1" "value1" ]] $msg.control[ctrl1] = “value1” creates a new ingrid protocol message data/control object with all properties as described in the definition
newControls alias newData func newData() Data [[ $ctrl1 := newData ]]<br>[[ $ctrl1 := setValue $ctrl1 "ctrl1" "value1" ]] $msg.control[ctrl1] = “value1” creates a new ingrid protocol message data/control object with all properties as described in the definition
newData func newData() Data [[ $ctrl1 := newData ]]<br>[[ $ctrl1 := setValue $ctrl1 "ctrl1" "value1" ]] $msg.control[ctrl1] = “value1” creates a new ingrid protocol message data/control object with all properties as described in the definition
newMsg func() Msg [[ $result := ]]
newRequest func() IngridMsg [[ $result := ]]
newResult func [[ $result := ]]
newSubRequest func() IngridMsg [[ $result := ]]
removeControlValue func(msg Msg, k string, v string) Msg [[ $msg := removeControlValue $msg "ctrl1" "value1" ]] $msg.control[ctrl1] = “” removes a specific value in a key in an ingrid message control part.
removeControlValueOnResult func(r Result, k, v string) Result [[ $result := removeControlValueOnResult $result "ctrl1" "value1" ]] $result.control[ctrl1] = “” removes a specific value in a key in a result control result part.
removeControlValues func(msg Msg, k string, v []string) Msg [[ $msg := removeControlValues $msg "ctrl1C" ( toStrings ( list "value1" "value2" ) ) ]] $msg.control[ctrl1] = “value3” removes specific values in a key in an ingrid message control part.
removeControlValuesOnResult func(r Result, k string, v []string) Result [[ $result := removeControlValuesOnResult $result "ctrl1" ( toStrings ( list "value1" "value2" ) ) ]] $result.control[ctrl1] = “value3” removes specific values in a key in a result control result part.
removeDataValue func(msg Msg, varname string, value string) Msg [[ $msg := removeDataValue $msg "data1" "value1" ]] $msg.data[data] = “” removes a specific value in a key in an ingrid message data part.
removeDataValueOnResult func(r Result, k, v string) Result [[ $result := removeDataValueOnResult $result "data1" "value1" ]] $result.data[data1] = “” removes a specific value in a key in a result data part.
removeDataValues func(msg Msg, varname string, values []string) Msg [[ $msg := removeDataValues $msg "data1D" ( toStrings ( list "value1" "value2" ) ) ]] $msg.data[data1] = “value3” removes specific values in a key in an ingrid message data part.
removeDataValuesOnResult func(r Result, k string, v []string) Result [[ $result := removeDataValuesOnResult $result "data1" ( toStrings ( list "value1" "value2" ) ) ]] $result.data[data1] = “value3” removes specific values in a key in a result data part.
removeResultControlValue func(msg Msg, varname string, value string) Msg [[ $msg := removeResultControlValue $msg "ctrl1" "value1" ]] $msg.result.control[ctrl1] = “” removes specific value in a key in an ingrid message result control part.
removeResultControlValues func(msg Msg, varname string, values []string) Msg [[ $msg := removeResultControlValues $msg "ctrl1RC" ( toStrings ( list "value1" "value2" ) ) ]] $msg.result.control[ctrl1] = “value3” removes specific values in a key in an ingrid message result control part.
removeResultDataValue func(msg Msg, varname string, value string) Msg [[ $msg := removeResultDataValue $msg "data1" "value1" ]] $msg.result.data[data1] = “” removes specific value in a key in an ingrid message result data part.
removeResultDataValues func(msg Msg, varname string, values []string) Msg [[ $msg := removeResultDataValues $msg "data1RD" ( toStrings ( list "value1" "value2" ) ) ]] $msg.result.data[data1] = “value3” removes specific values in a key in an ingrid message result data part.
removeValue func(in interface{}, name string, value string) Data [[ $msg := removeValue $msg "msgfield1" "value1" ]] $msg.data[msgfield1] = “” removes specific value in a key in a specified ingrid message part via interface.
removeValues func(in interface{}, name string, values []string) Data [[ $msg := removeValues $msg "msgfield1" ( toStrings ( list "value1" "value2" ) ) ]] $msg.data[msgfield1] = “value3” removes specific values in a key in a specified ingrid message part via interface.
setClass func [[ $result := ]]
setCode func [[ $result := ]]
setCodeOnResult func [[ $result := ]]
setControl func [[ $result := ]]
setControlOnResult func [[ $result := ]]
setControls func [[ $result := ]]
setControlsOnResult func [[ $result := ]]
setControlValue func [[ $result := ]]
setControlValueOnResult func [[ $result := ]]
setControlValues func [[ $result := ]]
setControlValuesOnResult func [[ $result := ]]
setCurrentRequest func() IngridMsg bool [[ $result := ]]
setData func [[ $result := ]]
setDataOnResult func [[ $result := ]]
setDataValue func [[ $result := ]]
setDataValueOnResult func [[ $result := ]]
setDataValues func [[ $result := ]]
setDataValuesOnResult func [[ $result := ]]
setList func [[ $result := ]]
setListOnResult func [[ $result := ]]
setMessage func [[ $result := ]]
setMessageOnResult func [[ $result := ]]
setMsg func() IngridMsg bool [[ $result := ]]
setMsgOnResult func [[ $result := ]]
setOperation func [[ $result := ]]
setRequest func() IngridMsg bool [[ $result := ]]
setResult func [[ $result := ]]
setResultCode func [[ $result := ]]
setResultControl func [[ $result := ]]
setResultControls func [[ $result := ]]
setResultControlValue func [[ $result := ]]
setResultControlValues func [[ $result := ]]
setResultData func [[ $result := ]]
setResultDataValue func [[ $result := ]]
setResultDataValues func [[ $result := ]]
setResultList func [[ $result := ]]
setResultMessage func [[ $result := ]]
setResultMsg func [[ $result := ]]
setValue func [[ $result := ]]
setValueOnResult func [[ $result := ]]
setValues func [[ $result := ]]
setValuesOnResult func [[ $result := ]]

To get an overview of the ingrid get/set request function check the cheat sheet.

addControlValue

func(msg Msg, k string, v string) Msg

The addControlValue function adds a key value pair to the ingrid message control part.

Application notes / Limits:

  • if the key already exists, the value will be added.

Examples


[[ $msg    := newSubRequest ]]
[[ $msg    := addControlValue $msg "keyfield1" "value field1" ]]
$msg.control[keyfield1] = "value field1"

addControlValueOnResult

func(r Result, k, v string) Result

The addControlValueOnResult function adds a key value pair to a result control part.

Examples


[[ $result := addControlValueOnResult $result "keyfield1" "value field1" ]]
$result.control[keyfield1] = "value field1"

[[ $msg    := setResult newRequest $result ]]
result.control[keyfield1] = "value field1"

addControlValues

func(msg Msg, k string, v []string) Msg { addValues(msg.Control, k, v); return msg }

The addControlValues function adds a key value pair with multiple values to an ingrid message control part.

Examples


[[ $msg    := newRequest ]]   
[[ $msg    := newSubRequest ]]
[[ $msg    := addControlValues $msg "keyfield1" ( toStrings ( list "value field1" ) ) ]]
$msg.control[keyfield1] = "value field1"

addControlValuesOnResult

func(r Result, k string, v []string) Result

The addControlValuesOnResult function adds a key value pair with multiple values to a result control part.

Examples


[[ $result := newResult ]]
[[ $result := addControlValuesOnResult $result "keyfield1"  ( toStrings ( list "value field1" "value2" ) ) ]]
$result.control[keyfield1] = "value field1 value2"

[[ $result  := newResult ]]
[[ $result  := addControlValuesOnResult $result "keyfield1"  ( toStrings ( list "abAB" ) ) ]]
[[ $result  := addControlValuesOnResult $result "keyfield1" ( split "10.0.0.1" "," )  ]]
$result.control[keyfield1] = "abAB 10.0.0.1"

addDataValue

func(msg Msg, varname string, value string) Msg

The addDataValue function adds a key value pair to the ingrid message data part.

Examples


[[ $msg := addDataValue $msg "keyfield1" "value field1" ]]
$msg.data[keyfield1] = "value field1"

addDataValueOnResult

func(r Result, k, v string) Result

The addDataValueOnResult function adds a key value pair to an ingrid message result data part.

Examples


[[ $result  := addDataValueOnResult $result "keyfield1" "value field1" ]]
$result.data[keyfield1] = "value field1"

addDataValues

func(msg Msg, varname string, values []string) Msg

The addDataValues function adds a key value pair with multiple values to an ingrid message data part.

Examples


[[ $msg    := newRequest ]]   
[[ $msg    := newSubRequest ]]
[[ $msg    := addDataValues $msg "keyfield1" ( toStrings ( list "value field1" ) ) ]]
$msg.data[keyfield1] = "value field1"

addDataValuesOnResult

func(r Result, k string, v []string) Result

The addDataValuesOnResult function adds a key value pair with multiple values to a result part.

Examples


[[ $result := newResult ]]
[[ $result := addDataValuesOnResult $result "keyfield1"  ( toStrings ( list "value1" "value2" ) ) ]]
$result.data[keyfield1] = "value1 value2"

[[ $result  := newResult ]]
[[ $result  := addDataValuesOnResult $result "keyfield1"  ( toStrings ( list "abAB" ) ) ]]
[[ $result  := addDataValuesOnResult $result "keyfield1" ( split "10.0.0.1" "," )  ]]
$result.data[keyfield1] = "abAB 10.0.0.1"

addResultControlValue

func (msg Msg, varname string, value string) Msg

The addResultControlValue function adds a key value pair to an ingrid message result control part.

Examples


[[ $msg := addResultControlValue $msg "keyfield1" "value field1" ]]
$msg.result.control[keyfield1] = "value field1"

addResultControlValues

func(msg Msg, varname string, values []string) Msg

The addResultControlValues function adds a key value pair with multiple values to an ingrid message result control part.

Examples


[[ $msg    := newSubRequest ]]
[[ $msg    := addResultControlValues $msg "keyfield1" ( toStrings ( list "value1" "value2"  ) ) ]]
$msg.result.control[keyfield1] = "value1 value2"

addResultDataValue

func(msg Msg, varname string, value string) Msg

The addResultDataValue function adds a key value pair to an ingrid message result data part.

Examples


[[ $msg := addResultDataValue $msg "keyfield1" "value field1" ]]
$msg.result.data[keyfield1] = "value field1"

addResultDataValues

func(msg Msg, varname string, values []string) Msg

The addResultDataValues function adds a key value pair with multiple values to an ingrid message result data part.

Examples


[[ $msg := newSubRequest ]]
[[ $msg := addResultDataValues $msg "keyfield1" ( toStrings ( list "value1" "value2"  ) ) ]]
$msg.result.data[keyfield1] = "value1 value2"

Example with list, split and add the content in 2 steps
[[ $msg := newSubRequest ]]
[[ $string1 := "Value1" ]]
[[ $string2 := "Value2" ]]
[[ $msg := addResultDataValues $msg "keyfield1" ( toStrings ( list $string1 $string2 ) ) ]]
[[ $msg := addResultDataValues $msg "keyfield1" ( split "10.0.0.1" "." )  ]]
$msg.result.data[keyfield1] = "value1 value2 10 0 0 1"

addValue

func(in interface{}, name string, value string) Data

The addValue function adds a key value pair in a specified ingrid message part via interface.

Application notes / Limits:

  • Ingrid interface types could be:
    • Data
    • Message
    • Result

Examples


Examle with a new request
[[ $msg    := newSubRequest ]]
[[ $msg    := addValue $msg "keyfield1" "value field1" ]]
$msg.data[keyfield1] = "value field1"

Examle with a new result
[[ $result  := newResult ]]
[[ $result  := addValue $result "keyfield1" "value field1" ]]
$result.data[keyfield1] = "value field1"

Examle with a new data
[[ $data  := newData ]]
[[ $data  := addValue $data "keyfield1" "value field1" ]]
$data[keyfield1] = "value field1"

addValues

func(in interface{}, name string, values []string) Data

The addValues function adds a key value pair with multiple values in a specified ingrid message part via interface.

Application notes / Limits:

  • Ingrid interface types could be:
    • Data
    • Message
    • Result

Examples


example interface and message
[[ $msg    := newSubRequest ]]
[[ $msg    := addValues $msg "keyfield1" ( toStrings ( list "value1" "value2" ) ) ]]
$msg.data[keyfield1] = "value1 value2"

example interface and result
[[ $result  := newResult ]]
[[ $result  := addValues $result "keyfield1" ( toStrings ( list "value1" "value2" ) ) ]]
$result.data[keyfield1] = "value1 value2"

example interface and data
[[ $data  := newData ]]
[[ $data  := addValues $data "keyfield1" ( toStrings ( list "value1" "value2" ) ) ]]
$data[keyfield1] = "value1 value2"

clearControlValue

see function clearControlValues

clearControlValueOnResult

see function clearControlValuesOnResult

clearControlValues

func(msg Msg, varname string) Msg

The clearControlValues function clears all values in a specific key in an ingrid message control part.

Examples


[[ $msg := newSubRequest ]]
[[ $msg := setControlValue    $msg "keyfield1" "value1" ]]
[[ $msg := clearControlValues $msg "keyfield1" ]]
$msg.control[keyfield1] = ""

clearControlValuesOnResult

func(r Result, name string) Result

The clearControlValuesOnResult function clears all values in a specific key in a result control part.

Examples


[[ $result := newResult ]]   
[[ $result := setControlValueOnResult  $result "keyfield1" "value1" ]]
[[ $result := clearControlValuesOnResult $result "keyfield1" ]]
$msg.result.control[keyfield1] = ""

clearDataValue

see function clearDataValues

clearDataValueOnResult

see function clearDataValuesOnResult

clearDataValues

func(msg Msg, varname string) Msg

The clearDataValues function clears all values in a specific key in an ingrid message data part.

Examples


[[ $msg    := newSubRequest ]]
[[ $msg    := setDataValues $msg "keyfield1" ( toStrings ( list "This"  "is" "a" "test" "String" ) ) ]]
[[ $msg    := clearDataValues $msg "keyfield1"  ]]
$msg.data[keyfield1] = ""

Example with setDataValue
[[ $msg    := newSubRequest ]]
[[ $msg    := setDataValue  $msg "keyfield2" "value1" ]]
[[ $msg    := clearDataValue $msg "keyfield2" ]]
$msg.data[keyfield2] = ""

clearDataValuesOnResult

func(r Result, name string) Result

The clearDataValuesOnResult function clears all values in a specific key in a result data part.

Examples


[[ $result  := newResult ]]
[[ $result  := addDataValueOnResult $result "teststring1" $string1 ]]
[[ $result  := clearDataValuesOnResult $result "teststring1" ]]
$msg.result.data[teststring1] = ""

Examples with Values
[[ $result  := newResult ]]   
[[ $result  := setDataValuesOnResult $result "keyfield1" ( toStrings ( list "test" "String" ) ) ]]
[[ $result  := clearDataValueOnResult $result "keyfield1"  ]]
$msg.result.data[keyfield1] = ""

clearResultControlValue

see function clearResultControlValues

clearResultControlValues

func(msg Msg, varname string) Msg

The clearResultControlValues function clears all values in a specific key in an ingrid message result control part.

Examples


[[ $msg    := newSubRequest ]]
[[ $msg    := setResultControlValues $msg "keyfield1" ( toStrings ( list "This"  "is" "a" "test" "String" ) ) ]]
[[ $msg    := clearResultControlValues $msg "keyfield1"  ]]
$msg.result.control[keyfield1] = ""

Example with setDataValue
[[ $msg    := newSubRequest ]]
[[ $msg    := setDataValue  $msg "keyfield2" "value1" ]]
[[ $msg    := clearResultControlValue $msg "keyfield2" ]]
$msg.data[keyfield2] = ""

clearResultDataValue

see function clearResultDataValues

clearResultDataValues

func(msg Msg, varname string) Msg

The clearResultDataValues function clears all values in a specific key in an ingrid message result data part.

Examples


[[ $msg    := newSubRequest ]]
[[ $msg    := setResultDataValues $msg "keyfield1" ( toStrings ( list "This"  "is" "a" "test" "String" ) ) ]]
[[ $msg    := clearResultDataValues $msg "keyfield1" ]]
$msg.result.data[keyfield1] = ""

Example with setDataValue
[[ $msg    := newSubRequest ]]
[[ $msg    := setResultDataValue  $msg "keyfield2" "value1" ]]
[[ $msg    := clearResultDataValue $msg "keyfield2" ]]
$msg.data[keyfield2] = ""

clearValue

see function clearValues

clearValueOnResult

see function clearDataValuesOnResult

clearValues

func(in interface{}, name string) (data Data, err error)

The clearValueOnResult function clears all values in a specific key in a result data part.

Examples


example interface and result
[[ $result  := newResult ]]
[[ $result  := addValues $result "keyfield1" ( toStrings ( list "value1" "value2" ) ) ]]
[[ $result  := clearValues $result "keyfield1" ]]
$result.data[keyfield1] = "value1 value2"

clearValuesOnResult

see function clearDataValuesOnResult

getClass

// TODO

func() Msg

The getClass function ….

Application notes / Limits:

  • xx

Examples


[[ $result := getClass ???? ]]
$result = "????"

getCode

// TODO

func() Msg

The getCode function ….

Application notes / Limits:

  • xx

Examples


[[ $result := getCode ???? ]]
$result = "????"

getCodeOnResult

// TODO

func() Msg

The getCodeOnResult function ….

Application notes / Limits:

  • xx

Examples


[[ $result := getCodeOnResult ???? ]]
$result = "????"

getControl

// TODO

func() Msg

The getControl function ….

Application notes / Limits:

  • xx

Examples


[[ $result := getControl ???? ]]
$result = "????"

getControlKeys

// TODO

func() Msg

The getControlKeys function ….

Application notes / Limits:

  • xx

Examples


[[ $result := getControlKeys ???? ]]
$result = "????"

getControlKeysOnResult

// TODO

func() Msg

The getControlKeysOnResult function ….

Application notes / Limits:

  • xx

Examples


[[ $result := getControlKeysOnResult ???? ]]
$result = "????"

getControlOnResult

// TODO

func() Msg

The getControlOnResult function ….

Application notes / Limits:

  • xx

Examples


[[ $result := getControlOnResult ???? ]]
$result = "????"

getControls

// TODO

func() Msg

The getControls function ….

Application notes / Limits:

  • xx

Examples


[[ $result := getControls ???? ]]
$result = "????"

getControlsOnResult

// TODO

func() Msg

The getControlsOnResult function ….

Application notes / Limits:

  • xx

Examples


[[ $result := getControlsOnResult ???? ]]
$result = "????"

getControlValue

// TODO

func() Msg

The getControlValue function ….

Application notes / Limits:

  • xx

Examples


[[ $result := getControlValue ???? ]]
$result = "????"

getControlValueOnResult

// TODO

func() Msg

The getControlValueOnResult function ….

Application notes / Limits:

  • xx

Examples


[[ $result := getControlValueOnResult ???? ]]
$result = "????"

getControlValues

// TODO

func() Msg

The getControlValues function ….

Application notes / Limits:

  • xx

Examples


[[ $result := getControlValues ???? ]]
$result = "????"

getControlValuesOnResult

// TODO

func() Msg

The getControlValuesOnResult function ….

Application notes / Limits:

  • xx

Examples


[[ $result := getControlValuesOnResult ???? ]]
$result = "????"

getCurrentRequest

// TODO

func() Msg

The getCurrentRequest function returns the current requests ingrid protocol message data block.

Application notes / Limits:

  • xx

Examples


[[ $result := getCurrentRequest ???? ]]
$result = "????"

getData

// TODO

func() Msg

The getData function ….

Application notes / Limits:

  • xx

Examples


[[ $result := getData ???? ]]
$result = "????"

getDataKeys

// TODO

func() Msg

The getDataKeys function ….

Application notes / Limits:

  • xx

Examples


[[ $result := getDataKeys ???? ]]
$result = "????"

getDataKeysOnResult

// TODO

func() Msg

The getDataKeysOnResult function ….

Application notes / Limits:

  • xx

Examples


[[ $result := getDataKeysOnResult ???? ]]
$result = "????"

getDataOnResult

// TODO

func() Msg

The getDataOnResult function ….

Application notes / Limits:

  • xx

Examples


[[ $result := getDataOnResult ???? ]]
$result = "????"

getDataValue

// TODO

func() Msg

The getDataValue function ….

Application notes / Limits:

  • xx

Examples


[[ $result := getDataValue ???? ]]
$result = "????"

getDataValueOnResult

// TODO

func() Msg

The getDataValueOnResult function ….

Application notes / Limits:

  • xx

Examples


[[ $result := getDataValueOnResult ???? ]]
$result = "????"

getDataValues

// TODO

func() Msg

The getDataValues function ….

Application notes / Limits:

  • xx

Examples


[[ $result := getDataValues ???? ]]
$result = "????"

getDataValuesOnResult

// TODO

func() Msg

The getDataValuesOnResult function ….

Application notes / Limits:

  • xx

Examples


[[ $result := getDataValuesOnResult ???? ]]
$result = "????"

getID

// TODO

func() Msg

The getID function ….

Application notes / Limits:

  • xx

Examples


[[ $result := getID ???? ]]
$result = "????"

getKeys

// TODO

func() Msg

The getKeys function ….

Application notes / Limits:

  • xx

Examples


[[ $result := getKeys ???? ]]
$result = "????"

getKeysOnResult

// TODO

func() Msg

The getKeysOnResult function ….

Application notes / Limits:

  • xx

Examples


[[ $result := getKeysOnResult ???? ]]
$result = "????"

getList

// TODO

func() Msg

The getList function ….

Application notes / Limits:

  • xx

Examples


[[ $result := getList ???? ]]
$result = "????"

getListOnResult

// TODO

func() Msg

The getListOnResult function ….

Application notes / Limits:

  • xx

Examples


[[ $result := getListOnResult ???? ]]
$result = "????"

getMessage

// TODO

func() Msg

The getMessage function ….

Application notes / Limits:

  • xx

Examples


[[ $result := getMessage ???? ]]
$result = "????"

getMessageOnResult

// TODO

func() Msg

The getMessageOnResult function ….

Application notes / Limits:

  • xx

Examples


[[ $result := getMessageOnResult ???? ]]
$result = "????"

getMsg

see function description getRequest

getMsgOnResult

// TODO

func() Msg

The getMsgOnResult function ….

Application notes / Limits:

  • xx

Examples


[[ $result := getMsgOnResult ???? ]]
$result = "????"

getOperation

// TODO

func() Msg

The getOperation function ….

Application notes / Limits:

  • xx

Examples


[[ $result := getOperation ???? ]]
$result = "????"

getRequest

// TODO

func() Msg

The getRequest function ….

Application notes / Limits:

  • getRequest alias getMsg alias getCurrentRequest

Examples


[[ $result := getRequest ???? ]]
$result = "????"

getRequestID

// TODO

func(msg IngridMsg) string

The getRequestID function get the request ID of the ingrid protocol message.

Application notes / Limits:

  • xx

Examples


[[ $result := getRequestID ???? ]]
$result = "????"

getResult

// TODO

func() Msg

The getResult function ….

Application notes / Limits:

  • xx

Examples


[[ $result := getResult ???? ]]
$result = "????"

getResultCode

// TODO

func() Msg

The getResultCode function ….

Application notes / Limits:

  • xx

Examples


[[ $result := getResultCode ???? ]]
$result = "????"

getResultControl

// TODO

func() Msg

The getResultControl function ….

Application notes / Limits:

  • xx

Examples


[[ $result := getResultControl ???? ]]
$result = "????"

getResultControlKeys

// TODO

func() Msg

The getResultControlKeys function ….

Application notes / Limits:

  • xx

Examples


[[ $result := getResultControlKeys ???? ]]
$result = "????"

getResultControls

// TODO

func() Msg

The getResultControls function ….

Application notes / Limits:

  • xx

Examples


[[ $result := getResultControls ???? ]]
$result = "????"

getResultControlValue

// TODO

func() Msg

The getResultControlValue function ….

Application notes / Limits:

  • xx

Examples


[[ $result := getResultControlValue ???? ]]
$result = "????"

getResultControlValues

// TODO

func() Msg

The getResultControlValues function ….

Application notes / Limits:

  • xx

Examples


[[ $result := getResultControlValues ???? ]]
$result = "????"

getResultData

// TODO

func() Msg

The getResultData function ….

Application notes / Limits:

  • xx

Examples


[[ $result := getResultData ???? ]]
$result = "????"

getResultDataKeys

// TODO

func() Msg

The getResultDataKeys function ….

Application notes / Limits:

  • xx

Examples


[[ $result := getResultDataKeys ???? ]]
$result = "????"

getResultDataValue

// TODO

func() Msg

The getResultDataValue function ….

Application notes / Limits:

  • xx

Examples


[[ $result := getResultDataValue ???? ]]
$result = "????"

getResultDataValues

// TODO

func() Msg

The getResultDataValues function ….

Application notes / Limits:

  • xx

Examples


[[ $result := getResultDataValues ???? ]]
$result = "????"

getResultKeys

// TODO

func() Msg

The getResultKeys function ….

Application notes / Limits:

  • xx

Examples


[[ $result := getResultKeys ???? ]]
$result = "????"

getResultList

// TODO

func() Msg

The getResultList function ….

Application notes / Limits:

  • xx

Examples


[[ $result := getResultList ???? ]]
$result = "????"

getResultMessage

// TODO

func() Msg

The getResultMessage function ….

Application notes / Limits:

  • xx

Examples


[[ $result := getResultMessage ???? ]]
$result = "????"

getResultMsg

// TODO

func() Msg

The getResultMsg function ….

Application notes / Limits:

  • xx

Examples


[[ $result := getResultMsg ???? ]]
$result = "????"

getValue

// TODO

func() Msg

The getValue function ….

Application notes / Limits:

  • xx

Examples


[[ $result := getValue ???? ]]
$result = "????"

getValueOnResult

// TODO

func() Msg

The getValueOnResult function ….

Application notes / Limits:

  • xx

Examples


[[ $result := getValueOnResult ???? ]]
$result = "????"

getValues

// TODO

func() Msg

The getValues function ….

Application notes / Limits:

  • xx

Examples


[[ $result := getValues ???? ]]
$result = "????"

getValuesOnResult

// TODO

func() Msg

The getValuesOnResult function ….

Application notes / Limits:

  • xx

Examples


[[ $result := getValuesOnResult ???? ]]
$result = "????"

hasControlKey

// TODO

func() Msg

The hasControlKey function ….

Application notes / Limits:

  • xx

Examples


[[ $result := hasControlKey ???? ]]
$result = "????"

hasControlKeyOnResult

// TODO

func() Msg

The hasControlKeyOnResult function ….

Application notes / Limits:

  • xx

Examples


[[ $result := hasControlKeyOnResult ???? ]]
$result = "????"

hasControlKeys

// TODO

func() Msg

The hasControlKeys function ….

Application notes / Limits:

  • xx

Examples


[[ $result := hasControlKeys ???? ]]
$result = "????"

hasControlKeysOnResult

// TODO

func() Msg

The hasControlKeysOnResult function ….

Application notes / Limits:

  • xx

Examples


[[ $result := hasControlKeysOnResult ???? ]]
$result = "????"

hasControlValue

// TODO

func() Msg

The hasControlValue function ….

Application notes / Limits:

  • xx

Examples


[[ $result := hasControlValue ???? ]]
$result = "????"

hasControlValueOnResult

// TODO

func() Msg

The hasControlValueOnResult function ….

Application notes / Limits:

  • xx

Examples


[[ $result := hasControlValueOnResult ???? ]]
$result = "????"

hasControlValues

// TODO

func() Msg

The hasControlValues function ….

Application notes / Limits:

  • xx

Examples


[[ $result := hasControlValues ???? ]]
$result = "????"

hasControlValuesOnResult

// TODO

func() Msg

The hasControlValuesOnResult function ….

Application notes / Limits:

  • xx

Examples


[[ $result := hasControlValuesOnResult ???? ]]
$result = "????"

hasDataKey

// TODO

func() Msg

The hasDataKey function ….

Application notes / Limits:

  • xx

Examples


[[ $result := hasDataKey ???? ]]
$result = "????"

hasDataKeyOnResult

// TODO

func() Msg

The hasDataKeyOnResult function ….

Application notes / Limits:

  • xx

Examples


[[ $result := hasDataKeyOnResult ???? ]]
$result = "????"

hasDataKeys

// TODO

func() Msg

The hasDataKeys function ….

Application notes / Limits:

  • xx

Examples


[[ $result := hasDataKeys ???? ]]
$result = "????"

hasDataKeysOnResult

// TODO

func() Msg

The hasDataKeysOnResult function ….

Application notes / Limits:

  • xx

Examples


[[ $result := hasDataKeysOnResult ???? ]]
$result = "????"

hasDataValue

// TODO

func() Msg

The hasDataValue function ….

Application notes / Limits:

  • xx

Examples


[[ $result := hasDataValue ???? ]]
$result = "????"

hasDataValueOnResult

// TODO

func() Msg

The hasDataValueOnResult function ….

Application notes / Limits:

  • xx

Examples


[[ $result := hasDataValueOnResult ???? ]]
$result = "????"

hasDataValues

// TODO

func() Msg

The hasDataValues function ….

Application notes / Limits:

  • xx

Examples


[[ $result := hasDataValues ???? ]]
$result = "????"

hasDataValuesOnResult

// TODO

func() Msg

The hasDataValuesOnResult function ….

Application notes / Limits:

  • xx

Examples


[[ $result := hasDataValuesOnResult ???? ]]
$result = "????"

hasKey

// TODO

func() Msg

The hasKey function ….

Application notes / Limits:

  • xx

Examples


[[ $result := hasKey ???? ]]
$result = "????"

hasKeyOnResult

// TODO

func() Msg

The hasKeyOnResult function ….

Application notes / Limits:

  • xx

Examples


[[ $result := hasKeyOnResult ???? ]]
$result = "????"

hasKeys

// TODO

func() Msg

The hasKeys function ….

Application notes / Limits:

  • xx

Examples


[[ $result := hasKeys ???? ]]
$result = "????"

hasKeysOnResult

// TODO

func() Msg

The hasKeysOnResult function ….

Application notes / Limits:

  • xx

Examples


[[ $result := hasKeysOnResult ???? ]]
$result = "????"

hasList

// TODO

func() Msg

The hasList function ….

Application notes / Limits:

  • xx

Examples


[[ $result := hasList ???? ]]
$result = "????"

hasListOnResult

// TODO

func() Msg

The hasListOnResult function ….

Application notes / Limits:

  • xx

Examples


[[ $result := hasListOnResult ???? ]]
$result = "????"

hasResultControlKey

// TODO

func() Msg

The hasResultControlKey function ….

Application notes / Limits:

  • xx

Examples


[[ $result := hasResultControlKey ???? ]]
$result = "????"

hasResultControlKeys

// TODO

func() Msg

The hasResultControlKeys function ….

Application notes / Limits:

  • xx

Examples


[[ $result := hasResultControlKeys ???? ]]
$result = "????"

hasResultControlValue

// TODO

func() Msg

The hasResultControlValue function ….

Application notes / Limits:

  • xx

Examples


[[ $result := hasResultControlValue ???? ]]
$result = "????"

hasResultControlValues

// TODO

func() Msg

The hasResultControlValues function ….

Application notes / Limits:

  • xx

Examples


[[ $result := hasResultControlValues ???? ]]
$result = "????"

hasResultDataKey

// TODO

func() Msg

The hasResultDataKey function ….

Application notes / Limits:

  • xx

Examples


[[ $result := hasResultDataKey ???? ]]
$result = "????"

hasResultDataKeys

// TODO

func() Msg

The hasResultDataKeys function ….

Application notes / Limits:

  • xx

Examples


[[ $result := hasResultDataKeys ???? ]]
$result = "????"

hasResultDataValue

// TODO

func() Msg

The hasResultDataValue function ….

Application notes / Limits:

  • xx

Examples


[[ $result := hasResultDataValue ???? ]]
$result = "????"

hasResultDataValues

// TODO

func() Msg

The hasResultDataValues function ….

Application notes / Limits:

  • xx

Examples


[[ $result := hasResultDataValues ???? ]]
$result = "????"

hasResultList

// TODO

func() Msg

The hasResultList function ….

Application notes / Limits:

  • xx

Examples


[[ $result := hasResultList ???? ]]
$result = "????"

hasValue

// TODO

func() Msg

The hasValue function ….

Application notes / Limits:

  • xx

Examples


[[ $result := hasValue ???? ]]
$result = "????"

hasValueOnResult

// TODO

func() Msg

The hasValueOnResult function ….

Application notes / Limits:

  • xx

Examples


[[ $result := hasValueOnResult ???? ]]
$result = "????"

hasValues

// TODO

func() Msg

The hasValues function ….

Application notes / Limits:

  • xx

Examples


[[ $result := hasValues ???? ]]
$result = "????"

hasValuesOnResult

// TODO

func() Msg

The hasValuesOnResult function ….

Application notes / Limits:

  • xx

Examples


[[ $result := hasValuesOnResult ???? ]]
$result = "????"

newControl

see function description newData

newControls

see function description newData

newData

func() Data

The newData function creates a new ingrid protocol message data/control object with all properties as described in the definition

Application notes / Limits:

  • newControls alias newControl alias newData

Examples


[[ $req1  := newSubRequest ]]
[[ $ctrl1 := newData ]]
[[ $ctrl1 := setValue $ctrl1 "ctrl1" "value1" ]]
$msg.control[ctrl1] = "value1"

newMsg

// TODO

func() Data

The newMsg function creates a new ingrid protocol message object.

Application notes / Limits:

  • newMsg alias newRequest

Examples


_comment create new empty request
[[ $req := newMsg ]]
[[ $result := toString (marshal $req ) ]]
[[ setCurrentResultDataValue "DocuFixValue7" $result ]]

newRequest

see function description newMsg

newResult

// TODO

func() Result

The newResult function creates a new ingrid protocol message result object

Application notes / Limits:

  • xx

Examples


[[ $result := newResult ???? ]]
$result = "????"

newSubRequest

// TODO

func() Msg { return newSubRequest(data.Data.ID) }

The newSubRequest function creates a new subrequest in the request.

Application notes / Limits:

  • It’s used to define a correlation to the previous request.
  • It’s logged to the logfile system
  • If you use newRequest, you won’t have a reference to the previous request.

Examples

Anpassen Beispiel: ist copy&paste von marshal


_comment request / subrequest relation
[[ $req1 := newSubRequest ]]
[[ $result := toString (marshal $req1 ) ]]
[[ setCurrentResultDataValue "DocuFixValue8" $result ]]

removeControlValue

func(msg Msg, k string, v string) Msg

The removeControlValue function removes a specific value in a key in an ingrid message control part.

Application notes / Limits:

  • If value in key doesn’t exists, it won’t do nothing.

Examples


[[ $msg    := newSubRequest ]]
[[ $msg    := setControlValue $msg "ctrl1" "value1" ]]
[[ $msg    := removeControlValue $msg "ctrl1" "value1" ]]
$msg.control[ctrl1] = ""

Removes the value from a list
[[ $msg    := newSubRequest ]]
[[ $msg    := setControlValue $msg "ctrl1" "value1" ]]
[[ $msg    := addControlValue $msg "ctrl1" "value2" ]]
[[ $msg    := removeControlValue $msg "ctrl1" "value1" ]]
$msg.control[ctrl1] = "value2"

removeControlValueOnResult

func(r Result, k, v string) Result

The removeControlValueOnResult function removes a specific value in a key in a result control part.

Application notes / Limits:

  • If value in key doesn’t exists, it won’t do nothing.

Examples


[[ $result := newResult ]]
[[ $result := setControlValueOnResult $result "ctrl1" "value1" ]]
[[ $result := removeControlValueOnResult $result "ctrl1" "value1" ]]
$result.control[ctrl1] = ""

Removes the value from a list
[[ $result := newResult ]]
[[ $result := setControlValueOnResult $result "ctrl1" "value1" ]]
[[ $result := addControlValueOnResult $result "ctrl1" "value2" ]]
[[ $result := removeControlValueOnResult $result "ctrl1" "value1" ]]
$result.control[ctrl1] = "value2"

removeControlValues

func(msg Msg, k string, v []string) Msg

The removeControlValues function removes specific values in a key in an ingrid message control part.

Application notes / Limits:

  • If value in key doesn’t exists, it won’t do nothing.

Examples


[[ $msg    := newSubRequest ]]
[[ $msg    := setControlValues $msg  "ctrl1C" ( toStrings ( list "value1" "value2" "value3" ) ) ]]
[[ $msg    := removeControlValues $msg "ctrl1C" ( toStrings ( list "value1" "value2" ) ) ]]
$msg.control[ctrl1] = "value3"

removeControlValuesOnResult

func(r Result, k string, v []string) Result

The removeControlValuesOnResult function removes specific values in a key in a result control part.

Application notes / Limits:

  • If value in key doesn’t exists, it won’t do nothing.

Examples


[[ $result := newResult ]]
[[ $result := setControlValuesOnResult $result "ctrl1" ( toStrings ( list "value1" "value2" "value3" ) ) ]]
[[ $result    := removeControlValuesOnResult $result "ctrl1" ( toStrings ( list "value1" "value2" ) ) ]]
$result.control[ctrl1] = "value3"

removeDataValue

func(msg Msg, varname string, value string) Msg

The removeDataValue function removes a specific value in a key in an ingrid message data part.

Application notes / Limits:

  • If value in key doesn’t exists, it won’t do nothing.

Examples


[[ $msg    := newSubRequest ]]
[[ $msg    := setDataValue $msg "data1" "value1" ]]
[[ $msg    := removeDataValue $msg "data1" "value1" ]]
$msg.data[data] = ""

Removes the value from a list
[[ $msg    := newSubRequest ]]
[[ $msg    := setDataValue $msg "data1" "value1" ]]
[[ $msg    := addDataValue $msg "data1" "value2" ]]
[[ $msg    := removeDataValue $msg "data1" "value1" ]]
$msg.data[data1] = "value2"

removeDataValueOnResult

func(r Result, k, v string) Result

The removeDataValueOnResult function removes a specific value in a key in a result data part.

Application notes / Limits:

  • If value in key doesn’t exists, it won’t do nothing.

Examples


[[ $result := newResult ]]
[[ $result := setDataValueOnResult $result "data1" "value1" ]]
[[ $result := removeDataValueOnResult $result "data1" "value1" ]]
$result.data[data1] = ""

Removes the value from a list
[[ $result := newResult ]]
[[ $result := setDataValueOnResult $result "data1" "value1" ]]
[[ $result := setDataValueOnResult $result "data1" "value2" ]]
[[ $result := removeDataValueOnResult $result "data1" "value1" ]]
$result.data[data1] = "value2"

removeDataValues

func(msg Msg, varname string, values []string) Msg

The removeDataValues function removes specific values in a key in an ingrid message data part.

Application notes / Limits:

  • If value in key doesn’t exists, it won’t do nothing.

Examples


[[ $msg    := newSubRequest ]]
[[ $msg    := setDataValues $msg "data1D" ( toStrings ( list "value1" "value2" "value3" ) ) ]]
[[ $msg    := removeDataValues $msg "data1D" ( toStrings ( list "value1" "value2" ) ) ]]
$msg.data[data1] = "value3"

removeDataValuesOnResult

func(r Result, k string, v []string) Result

The removeDataValuesOnResult function removes specific values in a key in a result data part.

Application notes / Limits:

  • If value in key doesn’t exists, it won’t do nothing.

Examples


[[ $result := newResult ]]
[[ $result := setDataValuesOnResult $result "data1" ( toStrings ( list "value1" "value2" "value3" ) ) ]]
[[ $result := removeDataValuesOnResult $result "data1" ( toStrings ( list "value1" "value2" ) ) ]]
$result.data[data1] = "value3"

removeResultControlValue

func(msg Msg, varname string, value string) Msg

The removeResultControlValue function removes specific value in a key in an ingrid message result control part.

Application notes / Limits:

  • If value in key doesn’t exists, it won’t do nothing.

Examples


[[ $msg := newSubRequest ]]
[[ $msg := setResultControlValue $msg "ctrl1" "value1" ]]
[[ $msg := removeResultControlValue $msg "ctrl1" "value1" ]]
$msg.result.control[ctrl1] = ""

multiple values and remove one
[[ $msg := newSubRequest ]]
[[ $msg := setResultControlValue $msg "ctrl1" "value1" ]]
[[ $msg := addResultControlValue $msg "ctrl1" "value2" ]]
[[ $msg := removeResultControlValue $msg "ctrl1" "value1" ]]
$msg.result.control[ctrl1] = "value2"

removeResultControlValues

func(msg Msg, varname string, values []string) Msg

The removeResultControlValues function removes specific values in a key in an ingrid message result control part.

Application notes / Limits:

  • If value in key doesn’t exists, it won’t do nothing.

Examples


[[ $msg := newSubRequest ]]
[[ $msg := setResultControlValues $msg "ctrl1RC" ( toStrings ( list "value1" "value2" "value3" ) ) ]]
[[ $msg := removeResultControlValues $msg "ctrl1RC" ( toStrings ( list "value1" "value2" ) ) ]]
$msg.result.control[ctrl1] = "value3"

removeResultDataValue

func(msg Msg, varname string, value string) Msg

The removeResultDataValue function removes specific value in a key in an ingrid message result data part.

Application notes / Limits:

  • If value in key doesn’t exists, it won’t do nothing.

Examples


[[ $msg := newSubRequest ]]
[[ $msg := setResultDataValue $msg "data1" "value1" ]]
[[ $msg := removeResultDataValue $msg "data1" "value1" ]]
$msg.result.data[data1] = ""

removeResultDataValues

func(msg Msg, varname string, values []string) Msg

The removeResultDataValues function removes specific values in a key in an ingrid message result data part.

Application notes / Limits:

  • If value in key doesn’t exists, it won’t do nothing.

Examples


[[ $msg := newSubRequest ]]
[[ $msg := setResultDataValues $msg "data1RD" ( toStrings ( list "value1" "value2" "value3" ) ) ]]
[[ $msg := removeResultDataValues $msg "data1RD" ( toStrings ( list "value1" "value2" ) ) ]]
$msg.result.data[data1] = "value3"

removeValue

func(in interface{}, name string, value string) Data

The removeValue function removes specific value in a key in a specified ingrid message part via interface.

Application notes / Limits:

  • Ingrid interface types could be:
    • Data
    • Message
    • Result

Examples


Examle with a new request
[[ $msg := newSubRequest ]]
[[ $msg := addValue    $msg "msgfield1" "value1" ]]
[[ $msg := removeValue $msg "msgfield1" "value1" ]]
$msg.data[msgfield1] = ""

Examle with a new result
[[ $result := newResult ]]
[[ $result := addValue    $result "resultfield1" "value1" ]]
[[ $result := removeValue $result "resultfield1" "value1" ]]
$result.data[resultfield1] = ""

Examle with a new data
[[ $data := newData ]]
[[ $data := addValue    $data "datafield1" "value1" ]]
[[ $data := removeValue $data "datafield1" "value1" ]]
$data[datafield1] = ""

removeValues

// TODO

func(in interface{}, name string, values []string) Data

The removeValues function removes specific values in a key in a specified ingrid message part via interface.

Application notes / Limits:

  • Ingrid interface types could be:
    • Data
    • Message
    • Result

Examples


example interface and message
[[ $msg := newSubRequest ]]
[[ $msg := addValues $msg "msgfield1" ( toStrings ( list "value1" "value2" "value3" ) ) ]][[ $msg    := removeValues $msg "msgfield1" ( toStrings ( list "value1" "value2" ) ) ]]
[[ $msg := removeValues $msg "msgfield1" ( toStrings ( list "value1" "value2" ) ) ]]
$msg.data[msgfield1] = "value3"

example interface and result
[[ $result := newResult ]]
[[ $result := addValues $result "resultfield1" ( toStrings ( list "value1" "value2" "value3" ) ) ]]
[[ $result := removeCurrentResultDataValues "resultfield1" ( toStrings ( list "value1" "value2" ) ) ]]
$result.data[keyfield1] = "value3"

example interface and data
[[ $data  := newData ]]
[[ $data  := addValues $data "datafield1" ( toStrings ( list "value1" "value2" "value3" ) ) ]]
[[ $data  := removeCurrentResultDataValues "datafield1" ( toStrings ( list "value1" "value2" ) ) ]]
$data[datafield1] = "value3"

setClass

// TODO

func() Msg

The setClass function ….

Application notes / Limits:

  • xx

Examples


[[ $result := setClass ???? ]]
$result = "????"

setCode

// TODO

func() Msg

The setCode function ….

Application notes / Limits:

  • xx

Examples


[[ $result := setCode ???? ]]
$result = "????"

setCodeOnResult

// TODO

func() Msg

The setCodeOnResult function ….

Application notes / Limits:

  • xx

Examples


[[ $result := setCodeOnResult ???? ]]
$result = "????"

setControl

// TODO

func (in interface{}, value Data) (msg Msg, err error)

The setControl function creates a new ingrid control object.

Application notes / Limits:

  • xx

Examples


[[ $result := setControl ???? ]]
$result = "????"

setControlOnResult

// TODO

func() Msg

The setControlOnResult function ….

Application notes / Limits:

  • xx

Examples


[[ $result := setControlOnResult ???? ]]
$result = "????"

setControls

// TODO

func() Msg

The setControls function ….

Application notes / Limits:

  • xx

Examples


[[ $result := setControls ???? ]]
$result = "????"

setControlsOnResult

// TODO

func() Msg

The setControlsOnResult function ….

Application notes / Limits:

  • xx

Examples


[[ $result := setControlsOnResult ???? ]]
$result = "????"

setControlValue

// TODO

func() Msg

The setControlValue function ….

Application notes / Limits:

  • xx

Examples


[[ $result := setControlValue ???? ]]
$result = "????"

setControlValueOnResult

// TODO

func() Msg

The setControlValueOnResult function ….

Application notes / Limits:

  • xx

Examples


[[ $result := setControlValueOnResult ???? ]]
$result = "????"

setControlValues

// TODO // TODO Problem with interface and list function.

func() Msg

The setControlValues function ….

Application notes / Limits:

  • xx

Examples


[[ $result := setControlValues ???? ]]
$result = "????"

setControlValuesOnResult

// TODO

func() Msg

The setControlValuesOnResult function ….

Application notes / Limits:

  • xx

Examples


[[ $result := setControlValuesOnResult ???? ]]
$result = "????"

setCurrentRequest

// TODO

func() IngridMsg bool == func(r Msg) bool { data.Data = &r; return true }?????

The setCurrentRequest function creates a new current ingrid message object.

Application notes / Limits:

Alias

  • setMsg
  • setRequest

Examples

Anpassen Beispiel: ist copy&paste von marshal


[[ $result := setCurrentRequest ???? ]]
$result = "????"

setData

// TODO

func() Msg

The setData function ….

Application notes / Limits:

  • xx

Examples


[[ $result := setData ???? ]]
$result = "????"

setDataOnResult

// TODO

func() Msg

The setDataOnResult function ….

Application notes / Limits:

  • xx

Examples


[[ $result := setDataOnResult ???? ]]
$result = "????"

setDataValue

// TODO

func() Msg

The setDataValue function ….

Application notes / Limits:

  • xx

Examples


[[ $result := setDataValue ???? ]]
$result = "????"

setDataValueOnResult

// TODO

func() Msg

The setDataValueOnResult function ….

Application notes / Limits:

  • xx

Examples


[[ $result := setDataValueOnResult ???? ]]
$result = "????"

setDataValues

// TODO

func() Msg

The setDataValues function ….

Application notes / Limits:

  • xx

Examples


[[ $result := setDataValues ???? ]]
$result = "????"

setDataValuesOnResult

// TODO

func() Msg

The setDataValuesOnResult function ….

Application notes / Limits:

  • xx

Examples


[[ $result := setDataValuesOnResult ???? ]]
$result = "????"

setList

// TODO

func() Msg

The setList function ….

Application notes / Limits:

  • xx

Examples


[[ $result := setList ???? ]]
$result = "????"

setListOnResult

// TODO

func() Msg

The setListOnResult function ….

Application notes / Limits:

  • xx

Examples


[[ $result := setListOnResult ???? ]]
$result = "????"

setMessage

// TODO

func() Msg

The setMessage function ….

Application notes / Limits:

  • xx

Examples


[[ $result := setMessage ???? ]]
$result = "????"

setMessageOnResult

// TODO

func() Msg

The setMessageOnResult function ….

Application notes / Limits:

  • xx

Examples


[[ $result := setMessageOnResult ???? ]]
$result = "????"

setMsg

see function description setCurrentRequest

setMsgOnResult

// TODO

func() Msg

The setMsgOnResult function ….

Application notes / Limits:

  • xx

Examples


[[ $result := setMsgOnResult ???? ]]
$result = "????"

setOperation

// TODO

func() Msg

The setOperation function ….

Application notes / Limits:

  • xx

Examples


[[ $result := setOperation ???? ]]
$result = "????"

setRequest

see function description setCurrentRequest

setResult

// TODO

func() Msg

The setResult function ….

Application notes / Limits:

  • xx

Examples


[[ $result := setResult ???? ]]
$result = "????"

setResultCode

// TODO

func() Msg

The setResultCode function ….

Application notes / Limits:

  • xx

Examples


[[ $result := setResultCode ???? ]]
$result = "????"

setResultControl

// TODO

func() Msg

The setResultControl function ….

Application notes / Limits:

  • xx

Examples


[[ $result := setResultControl ???? ]]
$result = "????"

setResultControls

// TODO

func() Msg

The setResultControls function ….

Application notes / Limits:

  • xx

Examples


[[ $result := setResultControls ???? ]]
$result = "????"

setResultControlValue

// TODO

func() Msg

The setResultControlValue function ….

Application notes / Limits:

  • xx

Examples


[[ $result := setResultControlValue ???? ]]
$result = "????"

setResultControlValues

// TODO

func() Msg

The setResultControlValues function ….

Application notes / Limits:

  • xx

Examples


[[ $result := setResultControlValues ???? ]]
$result = "????"

setResultData

// TODO

func() Msg

The setResultData function ….

Application notes / Limits:

  • xx

Examples


[[ $result := setResultData ???? ]]
$result = "????"

setResultDataValue

// TODO

func() Msg

The setResultDataValue function ….

Application notes / Limits:

  • xx

Examples


[[ $result := setResultDataValue ???? ]]
$result = "????"

setResultDataValues

// TODO

func() Msg

The setResultDataValues function ….

Application notes / Limits:

  • xx

Examples


[[ $result := setResultDataValues ???? ]]
$result = "????"

setResultList

// TODO

func() Msg

The setResultList function ….

Application notes / Limits:

  • xx

Examples


[[ $result := setResultList ???? ]]
$result = "????"

setResultMessage

// TODO

func() Msg

The setResultMessage function ….

Application notes / Limits:

  • xx

Examples


[[ $result := setResultMessage ???? ]]
$result = "????"

setResultMsg

// TODO

func() Msg

The setResultMsg function ….

Application notes / Limits:

  • xx

Examples


[[ $result := setResultMsg ???? ]]
$result = "????"

setValue

// TODO

func() Msg

The setValue function ….

Application notes / Limits:

  • xx

Examples


[[ $result := setValue ???? ]]
$result = "????"

setValueOnResult

// TODO

func() Msg

The setValueOnResult function ….

Application notes / Limits:

  • xx

Examples


[[ $result := setValueOnResult ???? ]]
$result = "????"

setValues

// TODO

func() Msg

The setValues function ….

Application notes / Limits:

  • xx

Examples


[[ $result := setValues ???? ]]
$result = "????"

setValuesOnResult

// TODO

func() Msg

The setValuesOnResult function ….

Application notes / Limits:

  • xx

Examples


[[ $result := setValuesOnResult ???? ]]
$result = "????"