Coverage Report - org.kuali.student.enrollment.courseregistration.infc.RegRequest
 
Classes in this File Line Coverage Branch Coverage Complexity
RegRequest
N/A
N/A
1
 
 1  
 package org.kuali.student.enrollment.courseregistration.infc;
 2  
 
 3  
 import java.util.List;
 4  
 
 5  
 import org.kuali.student.enrollment.acal.infc.Term;
 6  
 import org.kuali.student.r2.common.infc.IdEntity;
 7  
 
 8  
 /**
 9  
  * The request made to the service from the application to register for
 10  
  * course(s). The attributes of this entity include requester (which will be the
 11  
  * student in most cases), request id and term. Each of the reg group the
 12  
  * students want to register would be a registration request item in the Request
 13  
  * object. For every transactional operation from the application, a new
 14  
  * Registration request is created.
 15  
  * 
 16  
  * @author Kuali Student Team (sambit)
 17  
  */
 18  
 public interface RegRequest extends IdEntity {
 19  
 
 20  
     /**
 21  
      * The type of the overall registration request.
 22  
      * 
 23  
      * @see org.kuali.student.r2.common.infc.HasType#getTypeKey()
 24  
      */
 25  
     @Override
 26  
     public String getTypeKey();
 27  
 
 28  
     /**
 29  
      * Represents the state of the overall registration request.
 30  
      * 
 31  
      * @see org.kuali.student.r2.common.infc.HasState#getStateKey()
 32  
      */
 33  
     @Override
 34  
     public String getStateKey();
 35  
 
 36  
     /**
 37  
      * Returns the id of the person who requested the course registration. Most
 38  
      * of the times it would be a student but it could also be an admin or
 39  
      * faculty making a request on behalf of the student
 40  
      * 
 41  
      * @return
 42  
      */
 43  
     public String getRequestorId();
 44  
 
 45  
     /**
 46  
      * Returns the key of the {@link Term} of the registration request
 47  
      * 
 48  
      * @return
 49  
      */
 50  
     public String getTermId();
 51  
 
 52  
     /**
 53  
      * Returns a list of {@link RegRequestItem} that the RegRequest is composed
 54  
      * of.
 55  
      * 
 56  
      * @return
 57  
      */
 58  
     public List<? extends RegRequestItem> getRegRequestItems();
 59  
 
 60  
 }