001    /*
002     * Copyright 2011 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.kfs.module.endow.document.service;
017    
018    import java.util.Date;
019    import java.util.List;
020    
021    import org.kuali.rice.kns.util.KualiInteger;
022    
023    /**
024     * MonthEndDateService interface to provide the method to get month end date id
025     */
026    public interface MonthEndDateService {
027    
028        /**
029         * gets month end id date for a given monthEndId
030         * 
031         * @param monthEndId
032         * @return monthEndIdDate
033         */
034        public java.sql.Date getByPrimaryKey(KualiInteger monthEndId);
035        
036        /**
037         * Gets the most recent date.  it is basically the last record in END_ME_DT_T, 
038         * where the ID is the highest number
039         * @return mostRecentDate
040         */
041        public java.sql.Date getMostRecentDate();
042        
043        /**
044         * gets month end id
045         * 
046         * @param monthEndDate
047         * @return monthEndDateId
048         */
049        public KualiInteger getMonthEndId(Date monthEndDate);
050        
051        /**
052         * gets the next month end id for the new record
053         * 
054         * @return monthEndDateId
055         */
056        public KualiInteger getNextMonthEndIdForNewRecord();
057        
058        /**
059         * gets the first dates of month 
060         * 
061         * @return
062         */
063        public List<String> getBeginningDates();
064        
065        /**
066         * gets the month end dates
067         * 
068         * @return
069         */
070        public List<String> getEndingDates();
071            
072    }