1 /*
2 * The Kuali Financial System, a comprehensive financial management system for higher education.
3 *
4 * Copyright 2005-2014 The Kuali Foundation
5 *
6 * This program is free software: you can redistribute it and/or modify
7 * it under the terms of the GNU Affero General Public License as
8 * published by the Free Software Foundation, either version 3 of the
9 * License, or (at your option) any later version.
10 *
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU Affero General Public License for more details.
15 *
16 * You should have received a copy of the GNU Affero General Public License
17 * along with this program. If not, see <http://www.gnu.org/licenses/>.
18 */
19 package org.kuali.kfs.sys.service;
20
21
22 /**
23 * This class defines methods needed for batch to run successfully when there are dependencies on jobs that are run on external systems.
24 * Implementations of this interface are able to keep track of external job status and report it to the scheduler service.
25 *
26 */
27 public interface BatchModuleService {
28
29 /**
30 * This method returns whether a job is run on an external system.
31 *
32 * @param jobName a job name, such that calling {@link #isResponsibleForJob(String)} with this job name would return true
33 * @return whether this job runs from an external system
34 */
35 public boolean isExternalJob(String jobName);
36
37 /**
38 * This method returns the status of the given external job.
39 *
40 * @param jobName a job name, such that calling {@link #isResponsibleForJob(String)} with this job name would return true
41 * @return one of the status code constants defined in {@link org.kuali.kfs.sys.batch.service.SchedulerService}
42 */
43 public String getExternalJobStatus(String jobName);
44
45 }