View Javadoc

1   /*
2    * Copyright 2011 The Kuali Foundation Licensed under the Educational Community
3    * License, Version 1.0 (the "License"); you may not use this file except in
4    * compliance with the License. You may obtain a copy of the License at
5    * http://www.opensource.org/licenses/ecl1.php Unless required by applicable law
6    * or agreed to in writing, software distributed under the License is
7    * distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
8    * KIND, either express or implied. See the License for the specific language
9    * governing permissions and limitations under the License.
10   */
11  package org.kuali.student.r2.common.util.constants;
12  
13  import org.kuali.student.enrollment.lpr.dto.LuiPersonRelationInfo;
14  import org.kuali.student.r2.common.constants.CommonServiceConstants;
15  
16  /**
17   * Constants used by for LuiPersonRelationService
18   * 
19   * @author nwright
20   */
21  public class LuiPersonRelationServiceConstants {
22  
23      /**
24       * Reference Object URI's
25       */
26      public static final String NAMESPACE = CommonServiceConstants.REF_OBJECT_URI_GLOBAL_PREFIX + "lpr";
27      public static final String REF_OBJECT_URI_LUI_PERSON_RELATION = NAMESPACE + "/"
28              + LuiPersonRelationInfo.class.getSimpleName();
29      /**
30       * Types and known groups of types
31       */
32      public static final String LPR_KEY_PREFIX = "kuali.lpr";
33      public static final String INSTRUCTOR_MAIN_TYPE_KEY = "kuali.lpr.type.instructor.main";
34      public static final String INSTRUCTOR_ASSISTANT_TYPE_KEY = "kuali.lpr.type.instructor.assistant";
35      public static final String INSTRUCTOR_SUPPORT_TYPE_KEY = "kuali.lpr.type.instructor.support";
36      public static final String REGISTRANT_TYPE_KEY = "kuali.lpr.type.registrant";
37      public static final String ENROLLEE_TYPE_KEY = "kuali.lpr.type.enrollee";
38      public static final String ADVISOR_TYPE_KEY = "kuali.lpr.type.advisor";
39      // lpr transaction type
40      public static final String LPRTRANS_REGISTER_TYPE_KEY = "kuali.lpr.trans.type.register";
41      // lpr transaction item request options
42      public static final String LPRTRANS_ITEM__WAITLIST_OPTION_KEY = "kuali.lpr.option.waitlist";
43      public static final String LPRTRANS_ITEM_HOLD_UNTIL_LIST_OPTION_KEY = "kuali.lpr.option.hold.until.list";
44      // lpr transaction item types (operations)
45      public static final String LPRTRANS_ITEM_ADD_TYPE_KEY = "kuali.lpr.trans.item.type.add";
46      public static final String LPRTRANS_ITEM_DROP_TYPE_KEY = "kuali.lpr.trans.item.type.drop";
47      public static final String LPRTRANS_ITEM_SWAP_TYPE_KEY = "kuali.lpr.trans.item.type.swap";
48      public static final String LPRTRANS_ITEM_UPDATE_TYPE_KEY = "kuali.lpr.trans.item.type.update";
49      public static final String LPRTRANS_ITEM_ADD_TO_WAITLIST_TYPE_KEY = "kuali.lpr.trans.item.type.add.to.waitlist";
50      public static final String LPRTRANS_ITEM_ADD_TO_HOLD_UNTIL_LIST_TYPE_KEY = "kuali.lpr.trans.item.type.add.to.hold.until.list";
51      // transaction states
52      public static final String LPRTRANS_NEW_STATE_KEY = "kuali.lpr.trans.item.state.new";
53      public static final String LPRTRANS_SUCCEEDED_STATE_KEY = "kuali.lpr.trans.item.state.succeeded";
54      public static final String LPRTRANS_FAILED_STATE_KEY = "kuali.lpr.trans.state.failed";
55      public static final String LPRTRANS_DISCARDED_STATE_KEY = "kuali.lpr.trans.state.discarded";
56      // transaction item states
57      public static final String LPRTRANS_ITEM_NEW_STATE_KEY = "kuali.lpr.trans.item.state.new";
58      public static final String LPRTRANS_ITEM_SUCCEEDED_STATE_KEY = "kuali.lpr.trans.item.state.succeeded";
59      public static final String LPRTRANS_ITEM_FAILED_STATE_KEY = "kuali.lpr.trans.item.state.failed";
60      public static final String[] LPRTRANS_ITEM_TYPE_KEYS = {LPRTRANS_ITEM_UPDATE_TYPE_KEY, LPRTRANS_ITEM_ADD_TYPE_KEY,
61          LPRTRANS_ITEM_DROP_TYPE_KEY};
62      public static final String[] COURSE_INSTRUCTOR_TYPE_KEYS = {INSTRUCTOR_MAIN_TYPE_KEY,
63          INSTRUCTOR_ASSISTANT_TYPE_KEY, INSTRUCTOR_SUPPORT_TYPE_KEY};
64      public static final String[] COURSE_STUDENT_TYPE_KEYS = {REGISTRANT_TYPE_KEY};
65      /**
66       * LprRoster types
67       */
68      public static final String LPRROSTER_COURSE_FINAL_GRADEROSTER_TYPE_KEY = "kuali.lpr.roster.type.course.grade.final";
69      // reverted public static final String LPRROSTER_COURSE_FINAL_GRADEROSTER_TYPE_KEY = "kuali.roster.type.course.assessment.final ";
70      // roster type keys
71      // TODO: rename the one above to the one below as they point to the same thing
72      public static final String LPRROSTER_COURSE_FINAL_GRADE_TYPE_KEY = "kuali.lpr.roster.type.course.grade.final";
73      public static final String LPRROSTER_COURSE_MIDTERM_GRADE_TYPE_KEY = "kuali.lpr.roster.type.course.assessment.interim.midterm";
74      public static final String LPRROSTER_COURSE_WAITLIST_TYPE_KEY = "kuali.lpr.roster.type.course.waitlist";
75      public static final String LPRROSTER_COURSE_HOLD_UNTIL_LIST_TYPE_KEY = "kuali.lpr.roster.type.course.hold.until.list";    
76      /**
77       * LprRoster states
78       */
79        // grading roster process and state key
80      public static final String LPRROSTER_GRADING_POCESS_KEY = "kuali.lpr.roster.process.course.grading";
81      public static final String LPRROSTER_READY_STATE_KEY = "kuali.lpr.roster.state.ready";    
82      public static final String LPRROSTER_SAVED_STATE_KEY = "kuali.lpr.roster.state.saved";
83      public static final String LPRROSTER_SUBMITTED_STATE_KEY = "kuali.lpr.roster.state.submitted";
84      public static final String[] LPRROSTER_GRADING_POCESS_KEYS = {LPRROSTER_READY_STATE_KEY, LPRROSTER_SAVED_STATE_KEY,
85          LPRROSTER_SUBMITTED_STATE_KEY};
86      // other roster process state keys
87      public static final String LPRROSTER_LIST_POCESS_KEY = "kuali.lpr.roster.process.lists";   
88      public static final String LPRROSTER_CREATED_STATE_KEY = "kuali.lpr.roster.state.created";    
89      public static final String[] LPRROSTER_LIST_POCESS_KEYS = {LPRROSTER_CREATED_STATE_KEY};
90      // TODO: switch these constants to those above since they now point to the same thing
91      public static final String LPRROSTER_COURSE_FINAL_GRADEROSTER_NEW_STATE_KEY = "kuali.lpr.roster.state.created"; // Is this needed/to-be-used?
92      public static final String LPRROSTER_COURSE_FINAL_GRADEROSTER_READY_STATE_KEY = "kuali.lpr.roster.state.ready";
93      public static final String LPRROSTER_COURSE_FINAL_GRADEROSTER_SAVED_STATE_KEY = "kuali.lpr.roster.state.saved";
94      public static final String LPRROSTER_COURSE_FINAL_GRADEROSTER_SUBMITTED_STATE_KEY = "kuali.lpr.roster.state.submitted";
95      /**
96       * Student states to courses
97       */
98      public static final String PLANNED_STATE_KEY = "kuali.lpr.state.planned";
99      public static final String REGISTERED_STATE_KEY = "kuali.lpr.state.registered";
100     public static final String WAITLISTED_STATE_KEY = "kuali.lpr.state.waitlisted";
101     public static final String DROPPED_STATE_KEY = "kuali.lpr.state.dropped.early";
102     public static final String DROPPED_LATE_STATE_KEY = "kuali.lpr.state.dropped.late";
103     /**
104      * Instructor states
105      */
106     public static final String TENATIVE_STATE_KEY = "kuali.lpr.state.tentative";
107     public static final String ASSIGNED_STATE_KEY = "kuali.lpr.state.assigned";
108     public static final String UNASSIGNED_STATE_KEY = "kuali.lpr.state.unassigned";
109     /**
110      * Program states
111      */
112     public static final String INQUIRED_STATE_KEY = "kuali.lpr.state.inquired";
113     public static final String APPLIED_STATE_KEY = "kuali.lpr.state.applied";
114     public static final String ADMITTED_STATE_KEY = "kuali.lpr.state.admitted ";
115     public static final String DENIED_STATE_KEY = "kuali.lpr.state.denied";
116     public static final String CONFIRMED_STATE_KEY = "kuali.lpr.state.confirmed";
117     public static final String CANCELED_STATE_KEY = "kuali.lpr.state.canceled";
118     public static final String DEFERED_STATE_KEY = "kuali.lpr.state.defered";
119     public static final String ENROLLED_STATE_KEY = "kuali.lpr.state.enrolled";
120     public static final String TEMPORARY_ABSENCE_STATE_KEY = "kuali.lpr.state.temp.absence";
121     public static final String WITHDRAWN_STATE_KEY = "kuali.lpr.state.withdrawn";
122     public static final String PROBATION_STATE_KEY = "kuali.lpr.state.probation";
123     // advisor states
124     public static final String ACTIVE_STATE_KEY = "kuali.lpr.state.active";
125     public static final String INACTIVE_STATE_KEY = "kuali.lpr.state.inactive";
126     /**
127      * States used for isntructors of courses
128      */
129     public static final String INSTRUCTOR_COURSE_ASSIGNMENT_PROCESS_KEY = "kuali.lpr.process.instructor.course.assignment";
130     public static final String[] INSTRUCTOR_COURSE_ASSIGNMENT_STATE_KEYS = {TENATIVE_STATE_KEY, ASSIGNED_STATE_KEY,
131         UNASSIGNED_STATE_KEY};
132     /**
133      * States used for students in courses
134      */
135     public static final String STUDENT_COURSE_REGISTRATION_PROCESS_KEY = "kuali.lpr.process.student.course.registration";
136     public static final String[] STUDENT_COURSE_REGISTRATION_STATE_KEYS = {PLANNED_STATE_KEY, REGISTERED_STATE_KEY,
137         WAITLISTED_STATE_KEY, DROPPED_STATE_KEY, DROPPED_LATE_STATE_KEY};
138     /**
139      * States used for instructors of PROGRAMS
140      */
141     public static final String PROGRAM_ADVISOR_ASSIGNMENT_PROCESS_KEY = "kuali.lpr.process.program.advisor.assignment";
142     public static final String[] PROGRAM_ADVISOR_ASSIGNMENT_STATE_KEYS = {ACTIVE_STATE_KEY, INACTIVE_STATE_KEY};
143     /**
144      * Types used for students in PROGRAMS
145      */
146     public static final String STUDENT_PROGRAM_ENROLLMENT_PROCESS_KEY = "kuali.lpr.process.student.program.enrollment";
147     public static final String[] STUDENT_PROGRAM_ENROLLMENT_STATE_KEYS = {PLANNED_STATE_KEY, INQUIRED_STATE_KEY,
148         APPLIED_STATE_KEY, WAITLISTED_STATE_KEY, DENIED_STATE_KEY, CONFIRMED_STATE_KEY, CANCELED_STATE_KEY,
149         DEFERED_STATE_KEY, ENROLLED_STATE_KEY, TEMPORARY_ABSENCE_STATE_KEY, WITHDRAWN_STATE_KEY,
150         PROBATION_STATE_KEY};
151     /**
152      * All process keys
153      */
154     public static final String[] LPR_PROCESS_KEYS = {STUDENT_COURSE_REGISTRATION_PROCESS_KEY,
155         INSTRUCTOR_COURSE_ASSIGNMENT_PROCESS_KEY, STUDENT_PROGRAM_ENROLLMENT_PROCESS_KEY,
156         PROGRAM_ADVISOR_ASSIGNMENT_PROCESS_KEY};
157 }