001/*
002 * The Kuali Financial System, a comprehensive financial management system for higher education.
003 * 
004 * Copyright 2005-2014 The Kuali Foundation
005 * 
006 * This program is free software: you can redistribute it and/or modify
007 * it under the terms of the GNU Affero General Public License as
008 * published by the Free Software Foundation, either version 3 of the
009 * License, or (at your option) any later version.
010 * 
011 * This program is distributed in the hope that it will be useful,
012 * but WITHOUT ANY WARRANTY; without even the implied warranty of
013 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
014 * GNU Affero General Public License for more details.
015 * 
016 * You should have received a copy of the GNU Affero General Public License
017 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
018 */
019package org.kuali.kfs.gl.batch.service;
020
021import org.kuali.kfs.sys.batch.InitiateDirectory;
022
023
024/**
025 * The enterprise feeder is a component that feeds in origin entries from an external data source
026 */
027public interface EnterpriseFeederService extends InitiateDirectory{
028    public static final String DONE_FILE_SUFFIX = ".done";
029    public static final String DATA_FILE_SUFFIX = ".data";
030    public static final String RECON_FILE_SUFFIX = ".recon";
031
032    /**
033     * This method does the feeding
034     * 
035     * @param processName this merely identifies the process executing the feed. It will be used to build any error messages, but
036     *        computationally it should be ignored.
037     * @param performNotifications whether notifications should be sent out
038     */
039    public void feed(String processName, boolean performNotifications);
040
041    /**
042     * Returns the directory name from which files are loaded.
043     * @return the staging directory name
044     */
045    public String getDirectoryName();
046}