Package com.atlassian.bitbucket.ui

Interface PluginFormFragments

public interface PluginFormFragments

Collates a collection of enabled ContextualFormFragments plugin modules defined for a particular form.

See Also:

• PluginFormFragmentsFactory

Method Summary

Modifier and Type	Method	Description
void	execute(Map<String,String[]> requestParams)	Execute all of the ContextualFormFragments defined for this form.
String	getErrorHtml(Map<String,String[]> requestParams, Map<String,Collection<String>> fieldErrors)
String	getViewHtml()
void	validate(Map<String,String[]> requestParams, ValidationErrors errors)	Validate all ContextualFormFragments defined for this form.

Method Details

getViewHtml

@Nonnull
String getViewHtml()

Returns:

rendered HTML of all fields supplied by ContextualFormFragments defined for this form.

See Also:

• ContextualFormFragment.doView(java.lang.Appendable, java.util.Map<java.lang.String, java.lang.Object>)

validate

void validate(@Nonnull
 Map<String,String[]> requestParams,
 @Nonnull
 ValidationErrors errors)

Validate all ContextualFormFragments defined for this form.

Parameters:

requestParams - ServletRequest.getParameterMap() of the currently executing POST form submission

errors - the ValidationErrors object to be populated by any registered ContextualFormFragments

See Also:

• ContextualFormFragment.validate(java.util.Map<java.lang.String, java.lang.String[]>, com.atlassian.bitbucket.ui.ValidationErrors, java.util.Map<java.lang.String, java.lang.Object>)

getErrorHtml

@Nonnull
String getErrorHtml(@Nonnull
 Map<String,String[]> requestParams,
 @Nonnull
 Map<String,Collection<String>> fieldErrors)

Parameters:

requestParams - ServletRequest.getParameterMap() of the currently executing POST form submission

fieldErrors - a Map of String field names to sets of String error messages.

Returns:

rendered HTML of all fields supplied by ContextualFormFragments for this form when a validation error has occurred.

See Also:

• ContextualFormFragment.doError(java.lang.Appendable, java.util.Map<java.lang.String, java.lang.String[]>, java.util.Map<java.lang.String, java.util.Collection<java.lang.String>>, java.util.Map<java.lang.String, java.lang.Object>)

execute

void execute(@Nonnull
 Map<String,String[]> requestParams)

Execute all of the ContextualFormFragments defined for this form.

Parameters:

requestParams - ServletRequest.getParameterMap() of the currently executing POST form submission

See Also:

• ContextualFormFragment.execute(java.util.Map<java.lang.String, java.lang.String[]>, java.util.Map<java.lang.String, java.lang.Object>)