Prefill the questionnaire with an optional questionnaire response as an argument to the questionnaire fragment

[jingtang10]

This can be used to pre-fill the questionnaire while generating the UI.

[joiskash]

#227

[joiskash]

The order of questions within groups, groups within groups and groups within questions is relevant and must be retained for display and capture. The hierarchy items within the Questionnaire SHALL mirror the hierarchy of the corresponding Questionnaire (if any).

This allows us to assume that the QuestionnaireResponse structure will be corresponding to the Questionnaire from which it is derived. If there is a mismatch in the hierarchy the SDK will throw an error since in the context of SDC, the QuestionnaireResponse will always have a corresponding Questionnaire

[joiskash]

@jingtang10 so the plan is to

1. Introduce val questionnaireResponseJson in the gallery\QuestionnaireViewModel
2. Pass the questionnaireResponseJson as String? since it is optional to the Fragment arguments
3. In datacapture\QuestionnaireViewModel introduce a private fun Questionnaire.validateQuestionnaireResponse( questionnaireResponse : QuestionnaireResponse ) which will check and make sure that the hierarchy items within the Questionnaire SHALL mirror the hierarchy of the corresponding Questionnaire.
   What exception should be thrown if there is a mismatch in the structure?
4. In the second init block in datacapture\QuestionnaireViewModel I will introduce a check and see if state["QuestionnaireFragment.BUNDLE_KEY_QUESTIONNAIRE_RESPONSE"] not null then parse the questionnaireResponseJson and get the object questionnaireResponse
5. questionnaireResponseBuilder.addAllItem(questionnaireResponseJson.itemList) instead of the foreach block

Let me know if this is fine, I will start coding after your comments

[jingtang10]

thanks @joiskash.

so in step 4 you will use the validate method if a questionnnaire response is provided right?

So basically, if there is a questionnaire respoonse provided, validate it, if not, create a new one mirroring the structure (existing code).

[joiskash]

thanks @joiskash.

so in step 4 you will use the validate method if a questionnnaire response is provided right?

So basically, if there is a questionnaire respoonse provided, validate it, if not, create a new one mirroring the structure (existing code).

Yes that's right

[joiskash]

@jingtang10 If the structure of the questionnaire response provided does not match the questionnaire then should the library throw an error? or just warn the user?
And what error should be thrown if any?

[jingtang10]

I would rather for the library to throw an illegal argument exception than to swallow that issue.

[joiskash]

While validating is it fair to say that the order of the occurrence of item in the questionnaire will be the same in the questionnaire response?
eg if in the json string of the questionnaire linkid 1 is followed by 2 and in the json string of the questionnaire response linkid 2 is followed by 1. Should this throw an error or is this acceptable?

[jingtang10]

I don't think this is acceptable. The order should be maintained too in the questionnaire response structure.

…

On Wed, 17 Feb 2021 at 12:45, Kashyap Jois ***@***.***> wrote: While validating is it fair to say that the order of the occurrence of item in the questionnaire will be the same in the questionnaire response? eg if in the json string of the questionnaire linkid 1 is followed by 2 and in the json string of the questionnaire response linkid 2 is followed by 1. Should this throw an error or is this acceptable? — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#189 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AG3M2XDS6PLLGGP3ZBV32RTS7O27ZANCNFSM4WV2XRAQ> .

[jingtang10]

@joiskash can this be closed or is there something else you're still working on?

[joiskash]

This can be closed thanks :)

[jingtang10]

thanks and well done for resolving this issue.