Package jetbrains.buildServer.controllers.parameters.api

Interface ParameterControlProvider

All Superinterfaces:

ServerExtension, TeamCityExtension

All Known Implementing Classes:

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

@UserImplemented(adapterClass=ParameterControlProviderAdapter.class)
public interface ParameterControlProvider
extends ServerExtension

Extension point to provide custom editor control for build parameters

Since:

7.0

Author:

Eugene Petrenko (eugene.petrenko@gmail.com) Date: 08.09.11 12:30

See Also:

ParameterControlProviderAdapter

Method Summary

Modifier and Type	Method	Description
ParameterControlEditPresenter	getControlSpecEditPresenter()
ParameterControlViewPresenter	getControlViewPresenter()
String	getParameterDescription()	Parameter description that will be shown on control spec editor
String	getParameterType()	Parameter type that is used to match provider instance to control instance by ControlDescription.getParameterType()
void	validateParameterDescription(ParameterContext context)	Validated parameter specification.

Method Detail

getParameterType

@NotNull
String getParameterType()

Parameter type that is used to match provider instance to control instance by ControlDescription.getParameterType()

Returns:

control type Id

Since:

7.0

See Also:

ControlDescription.getParameterType()

getParameterDescription

@NotNull
String getParameterDescription()

Parameter description that will be shown on control spec editor

Returns:

human readable parameter description

Since:

7.0

validateParameterDescription

void validateParameterDescription(@NotNull
                                  ParameterContext context)
                           throws InvalidParametersException

Validated parameter specification. For some options it's required to allow to have invalid default parameter value, while it's necessary to validate parameter description without relation to value.

Parameters:

context - context

Throws:

InvalidParametersException - exception in validation error

Since:

7.0

getControlViewPresenter

@NotNull
ParameterControlViewPresenter getControlViewPresenter()

Returns:

parameter control view manager

Since:

7.0

getControlSpecEditPresenter

@Nullable
ParameterControlEditPresenter getControlSpecEditPresenter()

Returns:

parameter control specification edit manager

Since:

7.0