com.adobe.aemds.formset.service

Interface FormsetService

public interface FormsetService

The FormsetService provides a set of operation to query the forms inside a Formset. All the APIs take the Resource representing Formset will result in an exception (InvalidFormsetPathException). Some of the APIs also require a Form Number to query data w.r.t a particular Form. The FormNumber must be an integer between 1 and maximum Form Number in that Formset (whose path is provided as first argument). Unable to provide a valid Form Number will result in a InvalidFormNumberException.

Method Summary

Modifier and Type	Method and Description
String	getDataXML(org.apache.sling.api.resource.Resource formset, org.apache.sling.commons.json.JSONObject oFormsetState, boolean bKeepSubmittedFormNumber) Returns the data xml for the formset.
ArrayList<SubmittedForm>	getFormsetSubmissionInfo(org.apache.sling.api.resource.Resource formset, String xml) Takes the Data XML after the formset submission and breaks it down for each Form.
String	getPrefillJsonFromUrl(org.apache.sling.api.resource.Resource formset, int formNumber, String dataRef) Returns the PrefillJSON of a particular form (represented by formNumber) in a formset (represented by its formset Resource).
String	getTemplateJson(String formUid, com.adobe.aemds.formset.common.FormsetResource formsetResource) Returns the Stringified TemplateJSON of a particular form (represented by form Uid) in a formset (represented by its Formset Resource)
String	listForms(org.apache.sling.api.resource.Resource formset, String dataRef) Lists all the Forms that are present inside a Formset.

Method Detail

getTemplateJson

String getTemplateJson(String formUid,
                       com.adobe.aemds.formset.common.FormsetResource formsetResource)
                throws FormsetException

Returns the Stringified TemplateJSON of a particular form (represented by form Uid) in a formset (represented by its Formset Resource)

Parameters:

formUid -

formsetResource -

Returns:

Template JSON of the Form inside a Formset having Form Number as formNumber.

Throws:

FormsetException

listForms

String listForms(org.apache.sling.api.resource.Resource formset,
                 String dataRef)
          throws FormsetException

Lists all the Forms that are present inside a Formset.

Parameters:

formset -

Returns:

Returns a JSON representing all the Forms inside a Formset. The information that will be returned will be the formNumber, eligibility expression, dataRoot, formName, typeof form (xdp or af)

Throws:

FormsetException

getPrefillJsonFromUrl

String getPrefillJsonFromUrl(org.apache.sling.api.resource.Resource formset,
                             int formNumber,
                             String dataRef)
                      throws FormsetException

Returns the PrefillJSON of a particular form (represented by formNumber) in a formset (represented by its formset Resource). May return null if failed to get data root. The dataRef is assumed to be a valid URL that returns XML and doesn't requires any authentication. The Form is merged with the xml (returned by making a request to the URL) and the merged JSON (PrefillJSON) is returned.

Parameters:

formset -

formNumber -

dataRef - URL where the xml data is present

Returns:

prefill JSON of a particular form represented by form number in the given form set

Throws:

FormsetException

getDataXML

String getDataXML(org.apache.sling.api.resource.Resource formset,
                  org.apache.sling.commons.json.JSONObject oFormsetState,
                  boolean bKeepSubmittedFormNumber)
           throws FormsetException

Returns the data xml for the formset. The xml contains the submitted information (rendered forms and current form number). Current Form Number is added optionally if the bKeepSubmittedFormNumber is true, otherwise it is not added.

Parameters:

formset -

oFormsetState -

bKeepSubmittedFormNumber -

Returns:

data xml for the formset

Throws:

FormsetException

getFormsetSubmissionInfo

ArrayList<SubmittedForm> getFormsetSubmissionInfo(org.apache.sling.api.resource.Resource formset,
                                                  String xml)
                                           throws FormsetException

Takes the Data XML after the formset submission and breaks it down for each Form. The XML of each Form is returned along with the Form Name.

Parameters:

formset - CRX resource pointing to the Formset

xml - Submitted Data XML

Returns:

an ArrayList of Submitted Form containing the form name and data xml of each form filled in the Formset

Throws:

FormsetException

See Also:

SubmittedForm