Package jetbrains.buildServer.controllers.parameters.api

Interface ParameterControlViewPresenter

All Known Subinterfaces:

RemoteParameterControlProvider

All Known Implementing Classes:

CheckboxFieldParameterType, EnumParameterType, IntegerFieldParameterType, MultiselectFieldParameterType, ParameterControlProviderAdapter, PasswordFieldParameterType, RemoteParameterType, SelectParameterType, SelectParameterTypeBase, TextFieldParameterType

@UserImplemented(adapterClass=ParameterControlProviderAdapter.class)
public interface ParameterControlViewPresenter

Author:

Eugene Petrenko (eugene.petrenko@gmail.com) Date: 09.12.11 19:21

Method Summary

Modifier and Type	Method	Description
String	convertParameterValue(javax.servlet.http.HttpServletRequest request, ParameterRenderContext context, String value)	The method is called from framework to convert submitted value to value that would be save in the server settings Use #validateParameterValue(javax.servlet.http.HttpServletRequest, ParameterContext, String) do report detailed error
String	presentParameterValue(ParameterContext context, String value)	The method is called to translate parameter value to another textual representation that could be show to the user
org.springframework.web.servlet.ModelAndView	renderControl(javax.servlet.http.HttpServletRequest request, ParameterRenderContext context)	Called from framework to obtain parameter presentation for given request and context.
void	validateDefaultParameterValue(ParameterContext context, String value)	Called to validate server-provided default value.
Collection<InvalidProperty>	validateParameterValue(javax.servlet.http.HttpServletRequest request, ParameterRenderContext context, String value)	The method is called from framework to validate current control value.

Method Detail

renderControl

@NotNull
org.springframework.web.servlet.ModelAndView renderControl(@NotNull
                                                           javax.servlet.http.HttpServletRequest request,
                                                           @NotNull
                                                           ParameterRenderContext context)
                                                    throws InvalidParametersException

Called from framework to obtain parameter presentation for given request and context.
Control must fit it's width to parent contaner size
Framework will add to returned model parameter named 'context' with context parameter value Use <ext:registerTypedParameterScript> custom tag to subscribe control to javascript events. See customControl.js for interface declaration.

Parameters:

request - http request

context - parameter context

Returns:

ModelAndView pointing to .jsp file to render

Throws:

InvalidParametersException

Since:

7.0

validateDefaultParameterValue

void validateDefaultParameterValue(@NotNull
                                   ParameterContext context,
                                   @Nullable
                                   String value)
                            throws InvalidParametersException

Called to validate server-provided default value.
This method is called from parameter spec editor and for default parameters on custom run dialog build start.

Parameters:

context - parameter definition

value - value to validate

Throws:

InvalidParametersException - exception if value is invalid

Since:

7.0

validateParameterValue

@NotNull
Collection<InvalidProperty> validateParameterValue(@NotNull
                                                   javax.servlet.http.HttpServletRequest request,
                                                   @NotNull
                                                   ParameterRenderContext context,
                                                   @Nullable
                                                   String value)
                                            throws InvalidParametersException

The method is called from framework to validate current control value.

Parameters:

context - parameter context

value - control value

Returns:

collection of invalid properties to be shown for control

Throws:

InvalidParametersException - on generic validation error

Since:

7.0

convertParameterValue

@Nullable
String convertParameterValue(@NotNull
                             javax.servlet.http.HttpServletRequest request,
                             @NotNull
                             ParameterRenderContext context,
                             @Nullable
                             String value)
                      throws InvalidParametersException

The method is called from framework to convert submitted value to value that would be save in the server settings
Use #validateParameterValue(javax.servlet.http.HttpServletRequest, ParameterContext, String) do report detailed error

Parameters:

request - current request

context - parameter context

value - value to convert

Returns:

value to put to contenxt

Throws:

InvalidParametersException - exception on generic validation error

Since:

7.0

presentParameterValue

@NotNull
String presentParameterValue(@NotNull
                             ParameterContext context,
                             @Nullable
                             String value)

The method is called to translate parameter value to another textual representation that could be show to the user

Parameters:

context - parameter context

value - parameter value

Returns:

value to shot to the user

Since:

7.0