bpel-dao/src/main/java/org/apache/ode/bpel/dao/FilteredInstanceDeletable.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you 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 org.apache.ode.bpel.dao;

import java.util.Set;

import org.apache.ode.bpel.common.InstanceFilter;
import org.apache.ode.bpel.iapi.ProcessConf.CLEANUP_CATEGORY;

/**
 * An implementation of this interface provides a way to delete runtime process instances
 * through the InstanceFilter.
 *
 * @author sean
 *
 */
public interface FilteredInstanceDeletable {
    /**
     * Deletes instance filter by the given instance filter and clean up categories.
     *
     * @param filter instance filter
     * @param categories clean up categories
     * @return returns the number of instances that are deleted
     */
    int deleteInstances(InstanceFilter filter, Set<CLEANUP_CATEGORY> categories);
}