org.camunda.bpm.engine.history.SetRemovalTimeSelectModeForHistoricProcessInstancesBuilder 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;
/**
* Fluent builder to select the mode to set the removal time for historic process instances.
*
* @author Tassilo Weidner
*/
public interface SetRemovalTimeSelectModeForHistoricProcessInstancesBuilder extends SetRemovalTimeToHistoricProcessInstancesBuilder {
/**
* Sets the removal time to an absolute date.
*
* @param removalTime supposed to be set to historic entities.
* @return the builder.
*/
SetRemovalTimeToHistoricProcessInstancesBuilder absoluteRemovalTime(Date removalTime);
/**
* Calculates the removal time dynamically based on the respective process definition time to
* live and the process engine's removal time strategy.
*
*
In case {@link #hierarchical()} is enabled, the removal time is being calculated
* based on the base time and time to live of the historic root process instance.
*
* @return the builder.
*/
SetRemovalTimeToHistoricProcessInstancesBuilder calculatedRemovalTime();
/**
*
Sets the removal time to {@code null}.
*
* @return the builder.
*/
SetRemovalTimeToHistoricProcessInstancesBuilder clearedRemovalTime();
}