Coverage Report - org.kuali.student.enrollment.acal.infc.Holiday
 
Classes in this File Line Coverage Branch Coverage Complexity
Holiday
N/A
N/A
1
 
 1  
 /**
 2  
  * Copyright 2010 The Kuali Foundation Licensed under the
 3  
  * Educational Community License, Version 2.0 (the "License"); you may
 4  
  * not use this file except in compliance with the License. You may
 5  
  * obtain a copy of the License at
 6  
  *
 7  
  * http://www.osedu.org/licenses/ECL-2.0
 8  
  *
 9  
  * Unless required by applicable law or agreed to in writing,
 10  
  * software distributed under the License is distributed on an "AS IS"
 11  
  * BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
 12  
  * or implied. See the License for the specific language governing
 13  
  * permissions and limitations under the License.
 14  
  */
 15  
 
 16  
 package org.kuali.student.enrollment.acal.infc;
 17  
 
 18  
 import java.util.Date;
 19  
 
 20  
 import org.kuali.student.r2.common.infc.IdEntity;
 21  
 
 22  
 
 23  
 /**
 24  
  * Information about a holiday. Holdays are used to mark holidays and
 25  
  * other non-instructional days on a HolidayCalendar.
 26  
  *
 27  
  * @author tom
 28  
  * @since Tue Apr 05 14:22:34 EDT 2011
 29  
  */ 
 30  
 
 31  
 public interface Holiday 
 32  
     extends IdEntity {
 33  
 
 34  
     /**
 35  
      * Tests if this holiday is an instructional day.
 36  
      *
 37  
      * @name Is Instructional Day
 38  
      * @required
 39  
      */
 40  
     public Boolean getIsInstructionalDay();
 41  
 
 42  
     /**
 43  
      * Tests if this key date is an all day event. An all-day event
 44  
      * does not have a meaningful time component in the date.
 45  
      *
 46  
      * @name Is All Day
 47  
      * @required
 48  
      */
 49  
     public Boolean getIsAllDay();
 50  
   
 51  
     /**
 52  
      * Tests if this key date has a date range. 
 53  
      *
 54  
      * @return true if the end date is different than the start
 55  
      *         date, false if the start end end date are the same
 56  
      * @name Is Date Range
 57  
      * @required
 58  
      */
 59  
     public Boolean getIsDateRange();    
 60  
 
 61  
     /**
 62  
      * The start date and time of the key date.
 63  
      *
 64  
      * @name Start Date
 65  
      */
 66  
     public Date getStartDate();
 67  
     
 68  
     /**
 69  
      * The end date and time of the key date. The end
 70  
      * date must be equal to or greater that the start.
 71  
      *
 72  
      * @name End Date
 73  
      */
 74  
     public Date getEndDate();
 75  
 }