src/main/java/com/github/sebhoss/time/FiscalDateCalculator.java

   1 /*
   2  * This program is free software. It comes without any warranty, to
   3  * the extent permitted by applicable law. You can redistribute it
   4  * and/or modify it under the terms of the Do What The Fuck You Want
   5  * To Public License, Version 2, as published by Sam Hocevar. See
   6  * http://www.wtfpl.net/ for more details.
   7  */
   8 package com.github.sebhoss.time;
   9
  10 import org.joda.time.LocalDate;
  11
  12 /**
  13  * TODO: Write documentation
  14  */
  15 public interface FiscalDateCalculator {
  16
  17     /**
  18      * @param calendarDate
  19      *            The calendar date to transform.
  20      * @return The fiscal year of the given calendar date.
  21      */
  22     int calculateFiscalYear(LocalDate calendarDate);
  23
  24     /**
  25      * @param calendarDate
  26      *            The calendar date to transform.
  27      * @return The fiscal month of the given calendar date.
  28      */
  29     int calculateFiscalMonth(LocalDate calendarDate);
  30
  31     /**
  32      * @param calendarDate
  33      *            The calendar date to transform.
  34      * @return The fiscal week-of-year of the given calendar date.
  35      */
  36     int calculateFiscalWeekOfYear(LocalDate calendarDate);
  37
  38     /**
  39      * @param calendarDate
  40      *            The calendar date to transform.
  41      * @return The fiscal day-of-year of the given calendar date.
  42      */
  43     int calculateFiscalDayOfYear(LocalDate calendarDate);
  44
  45 }