Coverage Report - org.kuali.student.common.infc.State
 
Classes in this File Line Coverage Branch Coverage Complexity
State
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.common.infc;
 17  
 
 18  
 /**
 19  
  * Describes the state of an object
 20  
  *
 21  
  * States are used in Kuali Student to decribe where the entity is within a process
 22  
  *
 23  
  * For example: A new course may be created in a "draft" state, then move to a "submitted"
 24  
  * state for review until it is finally "approved".
 25  
  *
 26  
  * Most of validation of the the fields on the entity should be based on state in combination with the entity's type.
 27  
  *
 28  
  * @author nwright
 29  
  */
 30  
 public interface State extends HasKey, HasAttributes, HasEffectiveDates {
 31  
     
 32  
    
 33  
     /**
 34  
      * Name: Name
 35  
      *
 36  
      * Friendly name of the State
 37  
      */
 38  
     public String getName();
 39  
 
 40  
     /**
 41  
      * Name: Description
 42  
      * 
 43  
      * Narrative description of the State
 44  
      */
 45  
     public String getDescr();
 46  
 
 47  
 
 48  
 }