Coverage Report

Coverage Report - org.kuali.student.enrollment.courseoffering.infc.SeatPoolDefinition

Classes in this File

 /*
  * Copyright 2010 The Kuali Foundation 
  *
  * Licensed under the Educational Community License, Version 2.0 (the
  * "License"); you may not use this file except in compliance with the
  * License. You may obtain a copy of the License at
  *
  * http://www.osedu.org/licenses/ECL-2.0
  *
  * Unless required by applicable law or agreed to in writing, software
  * distributed under the License is distributed on an "AS IS" BASIS,
  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
  * implied. See the License for the specific language governing
  * permissions and limitations under the License.
  */
 
 package org.kuali.student.enrollment.courseoffering.infc;
 
 import java.util.List;
 
 import org.kuali.student.r2.core.statement.dto.StatementTreeViewInfo;
 import org.kuali.student.r2.common.infc.IdEntity;
 
 /**
  * Information about a single seat pool that can be associated with
  * either a course offering or registration group. Seat pools provides
  * a handle for statements that will be used to created enrollment
  * restrictions based on capacity. Seat pools are ordered using rank
  * to enable the most restrictive pools to be filled first.
  * 
  * @author Kamal
  */
 
 public interface SeatPoolDefinition 
     extends IdEntity {
 
     /**
      * Course offering Id to which the seat pool is linked to. Course
      * Offering Id should be set only if the seat pool applies across
      * all the registration group in the course offering.
      *
      * @name Course Offering Id
      * @required
      */
     public String getCourseOfferingId();
     
     /**
      * List of registration groups that seat pool applies to.
      *
      * @name Registration Group Ids
      */
     public List<String> getRegistrationGroupIds();
     
     /** 
      * Count Maximum seats available through this seat pool.
      *
      * @name Maximum Seat
      * @required
      */
     public Integer getMaximumSeatCount();
 
     /**
      * Indicates the order in which this seat pool will be processed
      * during registration. During registration students should be
      * assigned to a seat pool with the lowest possible rank to which
      * he or she meets the restriction requirements.
      *
      * @name Processing Priority
      */
     public Integer getProcessingPriority();
 
     /**
      * Statement that defines the capacity restriction that apply to
      * this seat pool. 
      *
      * NOTE: linking to Statement Id instead of TreeView. The Process
      * service Check entity has an Agenda Id.
      *
      * @name Capacity Restriction Statement Id
      */
     public String getCapacityRestrictionStatementId();
 }

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.enrollment.courseoffering.infc;
18
19		import java.util.List;
20
21		import org.kuali.student.r2.core.statement.dto.StatementTreeViewInfo;
22		import org.kuali.student.r2.common.infc.IdEntity;
23
24		/**
25		* Information about a single seat pool that can be associated with
26		* either a course offering or registration group. Seat pools provides
27		* a handle for statements that will be used to created enrollment
28		* restrictions based on capacity. Seat pools are ordered using rank
29		* to enable the most restrictive pools to be filled first.
30		*
31		* @author Kamal
32		*/
33
34		public interface SeatPoolDefinition
35		extends IdEntity {
36
37		/**
38		* Course offering Id to which the seat pool is linked to. Course
39		* Offering Id should be set only if the seat pool applies across
40		* all the registration group in the course offering.
41		*
42		* @name Course Offering Id
43		* @required
44		*/
45		public String getCourseOfferingId();
46
47		/**
48		* List of registration groups that seat pool applies to.
49		*
50		* @name Registration Group Ids
51		*/
52		public List<String> getRegistrationGroupIds();
53
54		/**
55		* Count Maximum seats available through this seat pool.
56		*
57		* @name Maximum Seat
58		* @required
59		*/
60		public Integer getMaximumSeatCount();
61
62		/**
63		* Indicates the order in which this seat pool will be processed
64		* during registration. During registration students should be
65		* assigned to a seat pool with the lowest possible rank to which
66		* he or she meets the restriction requirements.
67		*
68		* @name Processing Priority
69		*/
70		public Integer getProcessingPriority();
71
72		/**
73		* Statement that defines the capacity restriction that apply to
74		* this seat pool.
75		*
76		* NOTE: linking to Statement Id instead of TreeView. The Process
77		* service Check entity has an Agenda Id.
78		*
79		* @name Capacity Restriction Statement Id
80		*/
81		public String getCapacityRestrictionStatementId();
82		}