Package nl.gx.forms.wmpformapi.engine
Interface FormSessionContext
-
public interface FormSessionContext
FormSessionContext contains information about a specific FormVersion to be used when rendering it. Currently it only contains the mapping from pages to formsteps.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
addStepToPageMapping(BasicFormVersion formVersion, FormElement formElement)
Adds a mapping from pages to formsteps based for the givenBasicFormVersion
in combination with the givenFormElement
to thisFormSessionContext
.Map<String,String>
getStepToPageMapping()
Returns a Map from FormStep identifier to URL that indicates on which page each FormStep should be rendered.void
setStepToPageMapping(Map<String,String> mapping)
Sets the Map from FormStep identifier to page that indicates on which page each FormStep should be rendered.
-
-
-
Method Detail
-
getStepToPageMapping
Map<String,String> getStepToPageMapping()
Returns a Map from FormStep identifier to URL that indicates on which page each FormStep should be rendered.- Returns:
- a Map from FormStep identifier to URL
-
setStepToPageMapping
void setStepToPageMapping(Map<String,String> mapping)
Sets the Map from FormStep identifier to page that indicates on which page each FormStep should be rendered.- Parameters:
mapping
- a Map from FormSteps to pages that indicates on which page each FormStep should be rendered
-
addStepToPageMapping
void addStepToPageMapping(BasicFormVersion formVersion, FormElement formElement)
Adds a mapping from pages to formsteps based for the givenBasicFormVersion
in combination with the givenFormElement
to thisFormSessionContext
.- Parameters:
formVersion
-BasicFormVersion
which contains the formsteps which should be added to the mapping.formElement
-FormElement
which renders one or more formsteps of the givenBasicFormVersion
.
-
-