001    /**
002     * Copyright 2004-2012 The Kuali Foundation
003     *
004     * Licensed under the Educational Community License, Version 2.0 (the "License");
005     * you may not use this file except in compliance with the License.
006     * You may obtain a copy of the License at
007     *
008     * http://www.opensource.org/licenses/ecl2.php
009     *
010     * Unless required by applicable law or agreed to in writing, software
011     * distributed under the License is distributed on an "AS IS" BASIS,
012     * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013     * See the License for the specific language governing permissions and
014     * limitations under the License.
015     */
016    package org.kuali.hr.time.batch.service;
017    
018    import java.util.List;
019    
020    import org.kuali.hr.time.batch.BatchJob;
021    
022    public interface BatchJobService {
023    
024            /**
025             * Fetch a BatchJob by a given ID
026             * @param batchJobId Database ID of the BatchJob to fetch.
027             * @return The BatchJob matching batchJobId.
028             */
029            public BatchJob getBatchJob(Long batchJobId);
030    
031        /**
032         * Provides a List of BatchJob objects that match the indicated hrPyCalendarEntryId.
033         * @param hrPyCalendarEntryId The id of PayCalendarEntries objects to match.
034         * @return List of BatchJob objects.
035         */
036        public List<BatchJob> getBatchJobs(String hrPyCalendarEntryId);
037    
038        /**
039         * Get a List of BatchJob objects for the given parameters.
040         *
041         * @param hrPyCalendarEntryId The pay calendar entry we are looking for.
042         * @param batchJobStatus Only jobs of this status will be returned.
043         * @return List of BatchJob objects.
044         */
045        public List<BatchJob> getBatchJobs(String hrPyCalendarEntryId, String batchJobStatus);
046    
047        /**
048         * Saves or updates the provided BatchJob.
049         * @param batchJob The object to save.
050         */
051        public void saveBatchJob(BatchJob batchJob);
052    }