Ingrid-Request

Index

All Ingrid_request functions

Name Function header Example Result Description Errorhandling
getCurrentRequest func() Msg
getID func(msg Msg) string
getMsg func() Msg
getRequest func() IngridMsg [[ $v := getRequest ]] $v contains the current Request, that was sent to the Workflow
getRequestID func(msg IngridMsg) string [[ $v := getRequestID $req]] get the RequestID of the Request $req
newControl func newData() pkgmsg.Data
newControls func newData() pkgmsg.Data
newData func newData() pkgmsg.Data
newMsg func() Msg
newSubRequest func() IngridMsg
setCurrentRequest func() IngridMsg bool
setMsg func() IngridMsg bool
setRequest func() IngridMsg bool

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

getCurrentRequest

// TODO // TODO: func() Msg = fun() IngridMsg????

func() Msg

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

Application notes / Limits:

  • xx

Examples


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

getID

// TODO

func() Msg

The getID function ….

Application notes / Limits:

  • xx

Examples


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

getMsg

see function description getRequest

getRequest

// TODO

func() IngridMsg

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 := getMsg ???? ]]
$result = "????"

newControl

see function description newData

// delete this desc?? // TODO

func() pkgmsg.Dat

The newControl function …

Application notes / Limits:

  • newControls alias newControl alias newData

Examples


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

newControls

see function description newData

// delete this desc?? // TODO diff zu newControl??? (multiple controls can be added/created??)

func() pkgmsg.Data

The newControls function …

Application notes / Limits:

  • newControls alias newControl alias newData

Examples


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

newData

// TODO

func() pkgmsg.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


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

newMsg

// TODO

func() pkgmsg.Data

The newMsg function creates a new ingrid protocol message object.

Application notes / Limits:

  • newMsg alias newRequest

Examples


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

newRequest

see function description newMsg

newResult

// TODO

func() pkgmsg.Result

The newResult function creates a new ingrid protocol message result object

Application notes / Limits:

  • xx

Examples


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

newSubRequest

// TODO

func() IngridMsg == func() pkgmsg.Msg { return newSubRequest(data.Data.ID) }?????

The newSubRequest function creates a new subrequest in the request.

Application notes / Limits:

Examples

Anpassen Beispiel: ist copy&paste von marshal


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

setCurrentRequest

// TODO

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

The setCurrentRequest function creates a new current ingrid message object.

Application notes / Limits:

  • setCurrentRequest alias setMsg alias setRequest

Examples

Anpassen Beispiel: ist copy&paste von marshal


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

setMsg

see function description setCurrentRequest

setRequest

see function description setCurrentRequest