/*
 * The Kuali Financial System, a comprehensive financial management system for higher education.
 * 
 * Copyright 2005-2014 The Kuali Foundation
 * 
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 * 
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
/*
 * Created on Aug 12, 2004
 */
package org.kuali.kfs.pdp.service;

import org.kuali.rice.kim.api.identity.Person;

/**
 * This class defines services for Batch maintenance.
 */
public interface BatchMaintenanceService {

    /**
     * This method cancels a pending Batch.
     * @param batchId the id of the batch to be canceled
     * @param note  a note stating the reason for the batch cancelation
     * @param user the user that performed the batch cancelation
     * @return true if batch successfully canceled, false otherwise
     */
    public boolean cancelPendingBatch(Integer batchId, String note, Person user);

    /**
     * This method holds a pending Batch.
     * @param batchId the id of the batch to perfomr hold on
     * @param note a nite stating the reason for holding batch
     * @param user the user that performed the batch hold
     * @return true if batch successfully hold, false otherwise
     */
    public boolean holdPendingBatch(Integer batchId, String note, Person user);

    /**
     * This method removes a hold on a Batch.
     * @param batchId the id of the batch we want to remove the hold
     * @param changeText a text stating the reason for removing the hold
     * @param user the user that removed hold on batch
     * @return  true if batch hold successfully removed, false otherwise
     */
    public boolean removeBatchHold(Integer batchId, String changeText, Person user);

    /**
     * This method checks if the batch has open payments.
     * @param batchId the id of the batch
     * @return returns true if batch has open payments, false otherwise
     */
    public boolean doBatchPaymentsHaveOpenStatus(Integer batchId);

    /**
     * This method checks if batch payments has open or held payments.
     * @param batchId the id of the batch
     * @return true if batch has open or held payments, false otherwise
     */
    public boolean doBatchPaymentsHaveOpenOrHeldStatus(Integer batchId);

    /**
     * This method checks if batch payments have held status.
     * @param batchId the id of the batch
     * @return true if batch payments have held status, false otherwise
     */
    public boolean doBatchPaymentsHaveHeldStatus(Integer batchId);
}