ca.bc.gov.open.cpf.plugin.api.RequestParameter Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of cpf-api-plugin Show documentation
Concurrent Processing Framework Business Application Plugin API
There is a newer version: 5.1.1-RELEASE
/*
 * Copyright © 2008-2016, Province of British Columbia
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *         http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package ca.bc.gov.open.cpf.plugin.api;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * The RequestParameter method annotation indicates that a setXXX method is
 * a structured input data parameter on a {@link 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 {@link 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;
}
 */
@Retention(RetentionPolicy.RUNTIME)
@Target(value = ElementType.METHOD)
public @interface RequestParameter {
  /**
   * The description of the request parameter to display on the plug-in overview
   * page and as instructions on the create job forms.
   */
  String description() default "";

  /**
   * 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.
   */
  String descriptionUrl() default "";

  /** The index (position) of the parameter in the input file form. */
  int index() default -1;

  /**
   * 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.
   */
  int length() default -1;

  /**
   * The maximum allowed value for numeric parameters. The string value will be converted to the
   * correct data type.
   */
  String maxValue() default "";

  /**
   * The minimum allowed value for numeric parameters. The string value will be converted to the
   * correct data type.
   */
  String minValue() default "";

  /**
   * The number of decimal places for fixed precision numeric types.
   */
  int scale() default -1;

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

}