View Javadoc

1   /**
2    * Copyright 2010 The Kuali Foundation 
3    *
4    * Licensed under the Educational Community License, Version 2.0 (the
5    * "License"); you may not use this file except in compliance with the
6    * License. You may obtain a copy of the License at
7    *
8    * http://www.osedu.org/licenses/ECL-2.0
9    *
10   * Unless required by applicable law or agreed to in writing, software
11   * distributed under the License is distributed on an "AS IS" BASIS,
12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
13   * implied. See the License for the specific language governing
14   * permissions and limitations under the License.
15   */
16  
17  package org.kuali.student.r2.common.infc;
18  
19  import java.util.Date;
20  
21  /**
22   * A common service pattern for entities. This interface is applied to
23   * temporal entities with effective dates.
24   *
25   * @author nwright
26   */
27  public interface HasEffectiveDates {
28  
29      /**
30       * Date/time this object became effective. Must be less than or
31       * equal to the expirationDate specified.
32       * 
33       * @name Effective Date
34       */
35      public Date getEffectiveDate();
36      
37      /**
38       * Date/time this relationship is no longer effective. Must be
39       * greater than or equal to the effectiveDate specified.
40       * 
41       * @name Expiration Date
42       */
43      public Date getExpirationDate();
44  }