Coverage Report - org.kuali.student.core.academiccalendar.infc.KeyDate
 
Classes in this File Line Coverage Branch Coverage Complexity
KeyDate
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.core.academiccalendar.infc;
 17  
 
 18  
 import java.util.Date;
 19  
 import org.kuali.student.common.infc.KeyEntity;
 20  
 
 21  
 
 22  
 /**
 23  
  * Information about a key date. A key date may represent a single
 24  
  * point in time or a range depending on the value of isDateRange().
 25  
  *
 26  
  * @Author tom
 27  
  * @Since Tue Apr 05 14:22:34 EDT 2011
 28  
  */ 
 29  
 
 30  
 public interface KeyDate extends KeyEntity {
 31  
 
 32  
     /**
 33  
      * Name: Is Date Range
 34  
      * Tests if this key date has a date range. 
 35  
      *
 36  
      * @return true if the end date is different than the start date,
 37  
      *         false if the start end end date ar ethe same
 38  
      */
 39  
     public Boolean getIsDateRange();
 40  
 
 41  
     /**
 42  
      * Name: Start Date
 43  
      * The start date and time of the key date.
 44  
      *
 45  
      * @return the key date start date 
 46  
      */
 47  
     public Date getStartDate();
 48  
 
 49  
     /**
 50  
      * Name: End Date 
 51  
      * The end date and time of the key date. The end
 52  
      * date must be equal to or greater that the start.
 53  
      *
 54  
      * @return the key date end date
 55  
      */
 56  
     public Date getEndDate();
 57  
 }