001/*
002 * Copyright 2008-2009 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 */
016package org.kuali.ole.sys.batch.dataaccess.impl;
017
018import java.sql.Date;
019import java.util.Calendar;
020import java.util.Collections;
021import java.util.GregorianCalendar;
022
023import org.apache.log4j.Logger;
024import org.kuali.ole.sys.OLEPropertyConstants;
025import org.kuali.ole.sys.businessobject.SystemOptions;
026import org.kuali.ole.sys.businessobject.UniversityDate;
027import org.kuali.rice.krad.service.BusinessObjectService;
028
029/**
030 * Performs custom fiscal year process for University Date records
031 */
032public class UniversityDateFiscalYearMakerImpl extends FiscalYearMakerImpl {
033    private static final Logger LOG = org.apache.log4j.Logger.getLogger(UniversityDateFiscalYearMakerImpl.class);
034
035    /**
036     * @see org.kuali.ole.coa.batch.dataaccess.impl.FiscalYearMakerHelperImpl#performCustomProcessing(java.lang.Integer)
037     */
038    @Override
039    public void performCustomProcessing(Integer baseFiscalYear, boolean firstCopyYear) {
040        int fiscalYearStartMonth = getFiscalYearStartMonth(baseFiscalYear);
041
042        // determine start date year, if start month is not January the year will be one behind the fiscal year
043        int startDateYear = baseFiscalYear;
044        if (Calendar.JANUARY == fiscalYearStartMonth) {
045            startDateYear += 1;
046        }
047        getPersistenceBrokerTemplate();
048        // start with first day of fiscal year and create records for each year up to end date
049        GregorianCalendar univPeriodDate = new GregorianCalendar(startDateYear, fiscalYearStartMonth, 1);
050
051        // setup end date
052        GregorianCalendar enddate = new GregorianCalendar(univPeriodDate.get(Calendar.YEAR), univPeriodDate.get(Calendar.MONTH), univPeriodDate.get(Calendar.DAY_OF_MONTH));
053        enddate.add(Calendar.MONTH, 12);
054        enddate.add(Calendar.DAY_OF_MONTH, -1);
055
056        // the fiscal year is always the year of the ending date of the fiscal year
057        Integer nextFiscalYear = enddate.get(Calendar.YEAR);
058
059        // get rid of any records already existing for next fiscal year
060        deleteNewYearRows(nextFiscalYear);
061
062        // initialize the period variables
063        int period = 1;
064        String periodString = String.format("%02d", period);
065        int compareMonth = univPeriodDate.get(Calendar.MONTH);
066        int currentMonth = compareMonth;
067
068        // loop through the dates until we are past end date
069        while (univPeriodDate.compareTo(enddate) <= 0) {
070            // if we hit period 13 something went wrong
071            if (period == 13) {
072                LOG.error("Hit period 13 while creating university date records");
073                throw new RuntimeException("Hit period 13 while creating university date records");
074            }
075            
076            // create the university date record
077            UniversityDate universityDate = new UniversityDate();
078            universityDate.setUniversityFiscalYear(nextFiscalYear);
079            universityDate.setUniversityDate(new Date(univPeriodDate.getTimeInMillis()));
080            universityDate.setUniversityFiscalAccountingPeriod(periodString);
081
082            businessObjectService.save(universityDate);
083
084            // add one to day for the next record
085            univPeriodDate.add(Calendar.DAY_OF_MONTH, 1);
086
087            // does this kick us into a new month and therefore a new accounting period?
088            compareMonth = univPeriodDate.get(Calendar.MONTH);
089            if (currentMonth != compareMonth) {
090                period = period + 1;
091                periodString = String.format("%02d", period);
092                currentMonth = compareMonth;
093            }
094        }
095    }
096
097    /**
098     * Removes all UniversityDate records for the given fiscal year
099     * 
100     * @param requestYear year to delete records for
101     */
102    protected void deleteNewYearRows(Integer requestYear) {
103        businessObjectService.deleteMatching(UniversityDate.class, Collections.singletonMap(OLEPropertyConstants.UNIVERSITY_FISCAL_YEAR, requestYear));
104
105        LOG.warn(String.format("\n rows for %d deleted", requestYear));
106    }
107
108    /**
109     * Retrieves the system options record for the base fiscal year to determine the fiscal year start month
110     * 
111     * @param baseFiscalYear fiscal year to retrieve options record for
112     * @return int fiscal year start month (0 being Jan)
113     */
114    protected int getFiscalYearStartMonth(Integer baseFiscalYear) {
115        SystemOptions systemOptions = new SystemOptions();
116        systemOptions.setUniversityFiscalYear(baseFiscalYear);
117
118        SystemOptions foundOptions = (SystemOptions) businessObjectService.retrieve(systemOptions);
119        if (foundOptions == null) {
120            LOG.error("Unable to retrieve system options record for fiscal year " + baseFiscalYear);
121            throw new RuntimeException("Unable to retrieve system options record for fiscal year " + baseFiscalYear);
122        }
123
124        Integer fiscalYearStartMonth = Integer.parseInt(foundOptions.getUniversityFiscalYearStartMo());
125
126        return fiscalYearStartMonth - 1;
127    }
128
129    /**
130     * @see org.kuali.ole.coa.batch.dataaccess.impl.FiscalYearMakerHelperImpl#doCustomProcessingOnly()
131     */
132    @Override
133    public boolean doCustomProcessingOnly() {
134        return true;
135    }
136
137    /**
138     * Gets the businessObjectService attribute.
139     * 
140     * @return Returns the businessObjectService.
141     */
142    protected BusinessObjectService getBusinessObjectService() {
143        return businessObjectService;
144    }
145
146    /**
147     * Sets the businessObjectService attribute value.
148     * 
149     * @param businessObjectService The businessObjectService to set.
150     */
151    public void setBusinessObjectService(BusinessObjectService businessObjectService) {
152        this.businessObjectService = businessObjectService;
153    }
154
155}