org.camunda.bpm.engine.cdi.annotation.ProcessVariable Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of camunda-engine-cdi-jakarta Show documentation

There is a newer version: 7.22.0-alpha5

Show newest version

/*
 * Copyright Camunda Services GmbH and/or licensed to Camunda Services GmbH
 * under one or more contributor license agreements. See the NOTICE file
 * distributed with this work for additional information regarding copyright
 * ownership. Camunda licenses this file to you under the Apache License,
 * Version 2.0; 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 org.camunda.bpm.engine.cdi.annotation;

import java.lang.annotation.Documented;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;

import jakarta.enterprise.util.Nonbinding;
import jakarta.inject.Qualifier;


/**
 * Annotation for qualifying injection points such that process variables are
 * injected. Requires a process instance to be managed
 * 
 * {@code @Inject @ProcessVariable Object accountNumber}
 * {@code @Inject @ProcessVariable("accountNumber") Object account}
 * 
 * In both cases, the process variable with the name 'accountNumber' is
 * injected. NOTE: injection points must be of type 'object'.
 * 
 * 
 * Can also be used to declare bean-properties to hold process variables in
 * combination with the {@link StartProcess} annotation: 
 * 
 * {@code @ProcessVariable }
 * String accountNumber;  // will be added as a process 
 *                        // variable to the 'billingProcess'
 * 
 * {@code @StartProcess("billingProcess")}
 * public void startBillingProcess() {
 *  ...
 * } 
 * 
 * 
 * @author Daniel Meyer
 */
@Qualifier
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface ProcessVariable {

  /**
   * The name of the process variable to look up. Defaults to the name of the
   * annotated field or parameter
   */
  @Nonbinding
  public String value() default "";

}