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  /**
20   * A common interface pattern for service entities.
21   *
22   * @author tom
23   * @since Tue Apr 05 14:22:34 EDT 2011
24   */
25  
26  public interface Entity
27      extends HasPrimaryKey,
28              TypeStateEntity {
29  
30      /**
31       * A display name for this entity.
32       *
33       * @name Name
34       */
35      public String getName();
36  
37  
38      /**
39       * A description of the entity.
40       *
41       * @name Description
42       */
43      public RichText getDescr();
44  }