View Javadoc
1   /*
2    * Copyright 2007 The Kuali Foundation
3    * 
4    * Licensed under the Educational Community License, Version 2.0 (the "License");
5    * you may not use this file except in compliance with the License.
6    * You may obtain a copy of the License at
7    * 
8    * http://www.opensource.org/licenses/ecl2.php
9    * 
10   * Unless required by applicable law or agreed to in writing, software
11   * distributed under the License is distributed on an "AS IS" BASIS,
12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13   * See the License for the specific language governing permissions and
14   * limitations under the License.
15   */
16  package org.kuali.ole.gl.batch.service;
17  
18  import org.kuali.ole.sys.batch.InitiateDirectory;
19  
20  
21  /**
22   * The enterprise feeder is a component that feeds in origin entries from an external data source
23   */
24  public interface EnterpriseFeederService extends InitiateDirectory{
25      public static final String DONE_FILE_SUFFIX = ".done";
26      public static final String DATA_FILE_SUFFIX = ".data";
27      public static final String RECON_FILE_SUFFIX = ".recon";
28  
29      /**
30       * This method does the feeding
31       * 
32       * @param processName this merely identifies the process executing the feed. It will be used to build any error messages, but
33       *        computationally it should be ignored.
34       * @param performNotifications whether notifications should be sent out
35       */
36      public void feed(String processName, boolean performNotifications);
37  
38      /**
39       * Returns the directory name from which files are loaded.
40       * @return the staging directory name
41       */
42      public String getDirectoryName();
43  }