View Javadoc

1   /**
2    * Copyright 2011 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  package org.kuali.student.r2.common.util.constants;
16  
17  import org.kuali.student.enrollment.acal.dto.AcademicCalendarInfo;
18  import org.kuali.student.enrollment.acal.dto.HolidayCalendarInfo;
19  import org.kuali.student.enrollment.acal.dto.HolidayInfo;
20  import org.kuali.student.enrollment.acal.dto.KeyDateInfo;
21  import org.kuali.student.enrollment.acal.dto.TermInfo;
22  import org.kuali.student.r2.common.constants.CommonServiceConstants;
23  import org.kuali.student.r2.core.constants.AtpServiceConstants;
24  
25  /**
26   * This class holds the constants used by the Academic Calendar service
27   *
28   * @author tom
29   */
30  public class AcademicCalendarServiceConstants {
31  
32      /**
33       * Reference Object URI's
34       */
35      // TODO replace "acal" in namespace with "academiccalendar"
36      public static final String NAMESPACE = CommonServiceConstants.REF_OBJECT_URI_GLOBAL_PREFIX + "acal";
37      public static final String SERVICE_NAME_LOCAL_PART = "AcademicCalendarService";
38      public static final String REF_OBJECT_URI_TERM = NAMESPACE + "/" + TermInfo.class.getSimpleName();
39      public static final String REF_OBJECT_URI_ACADEMIC_CALENDAR = NAMESPACE + "/" + AcademicCalendarInfo.class.getSimpleName();
40      public static final String REF_OBJECT_URI_HOLIDAY_CALENDAR = NAMESPACE + "/" + HolidayCalendarInfo.class.getSimpleName();
41      public static final String REF_OBJECT_URI_HOLIDAY = NAMESPACE + "/" + HolidayInfo.class.getSimpleName();
42      public static final String REF_OBJECT_URI_KEY_DATE = NAMESPACE + "/" + KeyDateInfo.class.getSimpleName();
43  
44      /**
45       * Academic Calendar Types
46       */
47      public static final String ACADEMIC_CALENDAR_TYPE_KEY = AtpServiceConstants.ATP_ACADEMIC_CALENDAR_TYPE_KEY;
48      public static final String HOLIDAY_CALENDAR_TYPE_KEY = AtpServiceConstants.ATP_HOLIDAY_CALENDAR_TYPE_KEY;
49      public static final String[] TERM_TYPE_KEYS = AtpServiceConstants.ATP_TERM_GROUPING;
50  
51      /**
52       * Dynamic Attributes Keys
53       */
54      public static final String CAMPUS_KEY_DYNAMIC_ATTRIBUTE_KEY = "kuali.atp.attribute.campus.key";
55  
56      /**
57       * Registration Date Groups
58       */
59      public static final String REGISTRATION_PERIOD_TYPE_KEY = AtpServiceConstants.MILESTONE_REGISTRATION_PERIOD_TYPE_KEY;
60      public static final String ADD_DATE_TYPE_KEY = AtpServiceConstants.MILESTONE_COURSE_SELECTION_PERIOD_END_TYPE_KEY;
61      public static final String DROP_DATE_TYPE_KEY = AtpServiceConstants.MILESTONE_DROP_DATE_TYPE_KEY;
62      public static final String CLASSES_TYPE_KEY = AtpServiceConstants.MILESTONE_INSTRUCTIONAL_PERIOD_TYPE_KEY;
63      public static final String FINAL_EXAM_PERIOD_TYPE_KEY = AtpServiceConstants.MILESTONE_FINAL_EXAM_PERIOD_TYPE_KEY;
64      // TODO: Map to Grading Start Date periods
65      // public static final String GRADING_PERIOD_START_TYPE_KEY = ????
66      public static final String GRADING_PERIOD_END_TYPE_KEY = AtpServiceConstants.MILESTONE_GRADES_DUE_TYPE_KEY;
67  
68      /**
69       * Academic Calendar Process
70       */
71      public static final String ACADEMIC_CALENDAR_PROCESS_KEY = AtpServiceConstants.ATP_LIFECYCLE_KEY;
72      public static final String ACADEMIC_CALENDAR_DRAFT_STATE_KEY = AtpServiceConstants.ATP_DRAFT_STATE_KEY;
73      public static final String ACADEMIC_CALENDAR_OFFICIAL_STATE_KEY = AtpServiceConstants.ATP_OFFICIAL_STATE_KEY;
74      public static final String[] ACADEMIC_CALENDAR_PROCESS_STATE_KEYS = {ACADEMIC_CALENDAR_DRAFT_STATE_KEY, ACADEMIC_CALENDAR_OFFICIAL_STATE_KEY};
75  
76      public static final String TERM_DRAFT_STATE_KEY = AtpServiceConstants.ATP_DRAFT_STATE_KEY;
77      public static final String TERM_OFFICIAL_STATE_KEY = AtpServiceConstants.ATP_OFFICIAL_STATE_KEY;
78  
79      public static final String HOLIDAY_CALENDAR_DRAFT_STATE_KEY = AtpServiceConstants.ATP_DRAFT_STATE_KEY;
80      public static final String HOLIDAY_CALENDAR_OFFICIAL_STATE_KEY = AtpServiceConstants.ATP_OFFICIAL_STATE_KEY;
81  }