001/**
002 * Copyright 2004-2014 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.kpme.tklm.time.rules.graceperiod.service;
017
018import java.util.List;
019
020import org.joda.time.DateTime;
021import org.joda.time.LocalDate;
022import org.kuali.kpme.tklm.time.rules.graceperiod.GracePeriodRule;
023import org.springframework.cache.annotation.Cacheable;
024
025public interface GracePeriodService {
026        /**
027         * Fetch GracePeriodRule as of a particular date
028         * @param asOfDate
029         * @return
030         */
031    @Cacheable(value= GracePeriodRule.CACHE_NAME, key="'asOfDate=' + #p0")
032        public GracePeriodRule getGracePeriodRule(LocalDate asOfDate);
033        /**
034         * Process grace period rule as of a particular date with the corresponding timestamp
035         * @param actualDateTime
036         * @param asOfDate
037         * @return
038         */
039        public DateTime processGracePeriodRule(DateTime actualDateTime, LocalDate asOfDate);
040        
041        /**
042         * Fetch Grace period rule by id
043         * @param tkGracePeriodId
044         * @return
045         */
046    @Cacheable(value= GracePeriodRule.CACHE_NAME, key="'tkGracePeriodId=' + #p0")
047        public GracePeriodRule getGracePeriodRule(String tkGracePeriodId);
048
049    List<GracePeriodRule> getGracePeriodRules(String hourFactor, String active, String showHistory);
050}