bpel-dao/src/main/java/org/apache/ode/bpel/dao/DeferredProcessInstanceCleanable.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.io.Serializable;

import javax.xml.namespace.QName;

/**
 * Instances and associated data for a ProcessDAO implementation that implements this
 * interface can be deleted in a deferred fashion.
 *
 * @author sean
 *
 */
public interface DeferredProcessInstanceCleanable {
    /**
     * Returns the database id.
     *
     * @return database id
     */
    Long getPidId();
    
    /**
     * Deletes instances and data for this process, the number of rows gets deletes is limited
     * by the transaction size.
     *
     * @param transactionSize the number of rows to delete
     * @return the number of rows actually deleted
     */
    int deleteInstances(int transactionSize);
}