Return from a server-side script in Behaviours

[MattS]

Is it documented anywhere what a server-side script should return in a Behaviour?

And while I'm asking, what are the expected semantics for returning from scripted conditions, validators and post functions in ScriptRunner? I did check the docs but may have missed this very useful information.

[JamieA · Accepted solution]

That is a good but tricky question. The next version will have some static typing smarts so you can see any errors before the script gets executed, unfortunately right now it's not going to help with return types (would be especially useful in script fields).

To try to answer the question:

> what a server-side script should return in a Behaviour

nothing, you change the client by calling methods like getFieldById(..).setFormValue("foo")

Those methods are defined in a superclass of the script but you don't see that... when the script finishes the state is transferred to the client.

> expected semantics for returning from:

• scripted conditions

For simple scripted condition, which is easiest and recommended, return boolean. For custom script condition, set passesCondition to true or false.

• validators

Simple scripted validator, return boolean. For custom script validator, return type is ignored, throw InvalidInputException to stop transition. 

• post-function

return value is ignored

• script field

A value that is indexed, and passed to the template if one is defined. So the return value should match the indexer and the template. The preview shows you when you have this wrong.

Now that the static type checking work is nearly there, we can show the binding variable names and types, and maybe also the return value.

[MattS]

Thanks, helpful