org.camunda.bpm.engine.history.HistoricDecisionOutputInstance Maven / Gradle / Ivy
/*
* 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.history;
import java.util.Date;
import org.camunda.bpm.engine.variable.value.TypedValue;
/**
* Represents one output variable of a decision evaluation.
*
* @author Philipp Ossler
*/
public interface HistoricDecisionOutputInstance {
/** The unique identifier of this historic decision output instance. */
String getId();
/** The unique identifier of the historic decision instance. */
String getDecisionInstanceId();
/** The unique identifier of the clause that the value is assigned for.
* Can be null if the decision is not implemented as decision table. */
String getClauseId();
/** The name of the clause that the value is assigned for.
* Can be null if the decision is not implemented as decision table. */
String getClauseName();
/** The unique identifier of the rule that is matched.
* Can be null if the decision is not implemented as decision table. */
String getRuleId();
/** The order of the rule that is matched.
* Can be null if the decision is not implemented as decision table. */
Integer getRuleOrder();
/** The name of the output variable. */
String getVariableName();
/**
* Returns the type name of the variable
*/
String getTypeName();
/**
* Returns the value of this variable instance.
*/
Object getValue();
/**
* Returns the {@link TypedValue} for this value.
*/
TypedValue getTypedValue();
/**
* If the variable value could not be loaded, this returns the error message.
*
* @return an error message indicating why the variable value could not be loaded.
*/
String getErrorMessage();
/**
* Returns time when the variable was created.
*/
Date getCreateTime();
/**
* Returns the root process instance id of the process instance
* on which the associated business rule task has been called.
*/
String getRootProcessInstanceId();
/** The time the historic decision instance will be removed. */
Date getRemovalTime();
}