Interface FormPathsHelperService

All Known Implementing Classes:

FormPathsHelperServiceImpl

public interface FormPathsHelperService

Method Summary

Modifier and Type	Method	Description
Optional<Component>	getComponentById(String formBase, FormScope scope, String id)
Set<String>	getFormPaths(String formBase, FormScope scope, boolean skipReadOnlyFields)
Set<String>	getFormPathsForFieldSet(String formBase, FormScope scope, String fieldset, boolean skipReadOnlyFields)

Method Details

getFormPaths

Set<String> getFormPaths(String formBase,
 FormScope scope,
 boolean skipReadOnlyFields)

Parameters:

formBase - String of the Form-Base for which the paths should get parsed

scope - FormScope of the Form-Base

skipReadOnlyFields - boolean whether fields with display-type="readonly" should be skipped

Returns:

Set of paths of the specified form

getFormPathsForFieldSet

Set<String> getFormPathsForFieldSet(String formBase,
 FormScope scope,
 String fieldset,
 boolean skipReadOnlyFields)

Parameters:

formBase - String of the Form-Base for which the paths should get parsed

scope - FormScope of the Form-Base

fieldset - String of the specific fieldset in the form

skipReadOnlyFields - boolean whether fields with display-type="readonly" should be skipped

Returns:

Set of paths of the specified fieldset from the specified form

getComponentById

Optional<Component> getComponentById(String formBase,
 FormScope scope,
 String id)

Parameters:

formBase - String of the Form-Base for which the Component should get found

scope - FormScope of the Form-Base

id - String of the id for the component in the form

Returns:

Component for id