org.camunda.bpm.engine.runtime.CaseInstanceBuilder Maven / Gradle / Ivy
Show all versions of camunda-engine Show documentation
/*
* 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.runtime;
import java.util.Map;
import org.camunda.bpm.engine.ProcessEngineException;
import org.camunda.bpm.engine.exception.NotFoundException;
import org.camunda.bpm.engine.exception.NotValidException;
/**
* A fluent builder to create a new case instance.
*
* @author Roman Smirnov
*
*/
public interface CaseInstanceBuilder {
/**
* A business key can be provided to associate the case instance with a
* certain identifier that has a clear business meaning. This business key can
* then be used to easily look up that case instance, see
* {@link CaseInstanceQuery#caseInstanceBusinessKey(String)}. Providing such a
* business key is definitely a best practice.
*
* Note that a business key MUST be unique for the given case definition WHEN
* you have added a database constraint for it. In this case, only case instance
* from different case definition are allowed to have the same business key and
* the combination of caseDefinitionKey-businessKey must be unique.
*
* @param businessKey
* a key that uniquely identifies the case instance in the context
* of the given case definition.
*
* @return the builder
*
*/
CaseInstanceBuilder businessKey(String businessKey);
/**
* Specify the id of the tenant the case definition belongs to. Can only be
* used when the definition is referenced by key and not by id.
*/
CaseInstanceBuilder caseDefinitionTenantId(String tenantId);
/**
* Specify that the case definition belongs to no tenant. Can only be
* used when the definition is referenced by key and not by id.
*/
CaseInstanceBuilder caseDefinitionWithoutTenantId();
/**
* Pass a variable to the case instance.
*
* Invoking this method multiple times allows passing multiple variables.
*
* @param variableName the name of the variable to set
* @param variableValue the value of the variable to set
*
* @return the builder
*
* @throws NotValidException when the given variable name is null
*/
CaseInstanceBuilder setVariable(String variableName, Object variableValue);
/**
* Pass a map of variables to the case instance.
*
* Invoking this method multiple times allows passing multiple variables.
*
* @param variables the map of variables
* @return the builder
*/
CaseInstanceBuilder setVariables(Map variables);
/**
* Creates a new {@link CaseInstance}, which will be in the ACTIVE state.
*
* @throws NotValidException when the given case definition key or id is null or
* @throws NotFoundException when no case definition is deployed with the given key or id.
* @throws ProcessEngineException when an internal exception happens during the execution of the command
*/
CaseInstance create();
}