ca.bc.gov.open.cpf.plugin.api

Annotation Type RequestParameter

@Retention(value=RUNTIME)
 @Target(value=METHOD)
public @interface RequestParameter

The RequestParameter method annotation indicates that a setXXX method is a structured input data parameter on a BusinessApplicationPlugin class that has perRequestInputData=false.

Request parameters are implemented as Java bean properties on the plug-in class. The plug-in must implement a setXXX property method for each request parameter. The request parameter name is the name of the Java bean property. The parameter type can only use the supported data types. The request parameters will be converted by the CPF from the input data to the correct Java type.

Before execution of the plug-in the request methods will be invoked to set the request parameter values.

A RequestParameter method can also be marked as a JobParameter if the parameter can be specified either at the job or request level.

The following example shows the use of the annotation.

private String algorithmName;

@RequestParameter
public void setAlgorithmName(final String algorithmName) {
  this.algorithmName = algorithmName;
}

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	description The description of the request parameter to display on the plug-in overview page and as instructions on the create job forms.
String	descriptionUrl The url to a page that describes the parameter in greater detail than is possible on the form.
int	index The index (position) of the parameter in the input file form.
int	length The maximum length of the parameter including the scale.
String	maxValue The maximum allowed value for numeric parameters.
String	minValue The minimum allowed value for numeric parameters.
int	scale The number of decimal places for fixed precision numeric types.
String	units The units of measurement for numeric fields (e.g.

Element Detail

description

public abstract String description

The description of the request parameter to display on the plug-in overview page and as instructions on the create job forms.

Default:

""

descriptionUrl

public abstract String descriptionUrl

The url to a page that describes the parameter in greater detail than is possible on the form. If specified the name of the parameter will be a hyper-link to this URL.

Default:

""

index

public abstract int index

The index (position) of the parameter in the input file form.

Default:

-1

length

public abstract int length

The maximum length of the parameter including the scale. This is ignored for fixed size data types such as boolean, byte, short, int, long, float and double. The value -1 indicates no defined limit to the scale.

Default:

-1

maxValue

public abstract String maxValue

The maximum allowed value for numeric parameters. The string value will be converted to the correct data type.

Default:

""

minValue

public abstract String minValue

The minimum allowed value for numeric parameters. The string value will be converted to the correct data type.

Default:

""

scale

public abstract int scale

The number of decimal places for fixed precision numeric types.

Default:

-1

units

public abstract String units

The units of measurement for numeric fields (e.g. metres, feet, degrees). This will be displayed after the field on the form.

Default:

""