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