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.population.dto.PopulationInfo;
19  import org.kuali.student.r2.core.population.dto.PopulationRuleInfo;
20  import org.kuali.student.r2.core.population.service.PopulationService;
21  
22  /**
23   * This class holds the constants used by the Population service.
24   *
25   * @author tom
26   */
27  public class PopulationServiceConstants {
28  
29      /**
30       * Reference Object URI's
31       */
32      public static final String SERVICE_NAME_LOCAL_PART = PopulationService.class.getSimpleName ();
33      public static final String NAMESPACE = CommonServiceConstants.REF_OBJECT_URI_GLOBAL_PREFIX + "population";
34      public static final String REF_OBJECT_URI_POPULATION = NAMESPACE + "/" + PopulationInfo.class.getSimpleName();
35      public static final String REF_OBJECT_URI_POPULATION_RULE = NAMESPACE + "/" + PopulationRuleInfo.class.getSimpleName();
36  
37      //////////////////////////////////
38      // POPULATION RULE
39      //////////////////////////////////
40  
41      /**
42       * PopulationRule types
43       */
44      public static final String POPULATION_RULE_TYPE_PERSON_KEY = "kuali.population.rule.type.person";
45      public static final String POPULATION_RULE_TYPE_RULE_KEY = "kuali.population.rule.type.rule";
46      public static final String POPULATION_RULE_TYPE_SEARCH_KEY = "kuali.population.rule.type.search";
47      public static final String POPULATION_RULE_TYPE_UNION_KEY = "kuali.population.rule.type.union";
48      public static final String POPULATION_RULE_TYPE_INTERSECTION_KEY = "kuali.population.rule.type.intersection";
49      public static final String POPULATION_RULE_TYPE_EXCLUSION_KEY = "kuali.population.rule.type.exclusion";
50  
51      /**
52       * States for Population Rule
53       */
54      public static final String POPULATION_RULE_LIFECYCLE_KEY = "kuali.population.population.rule.lifecycle";
55      public static final String POPULATION_RULE_ACTIVE_STATE_KEY = "kuali.population.population.rule.state.active";
56      public static final String POPULATION_RULE_INACTIVE_STATE_KEY = "kuali.population.population.rule.state.inactive";
57      public static final String[] POPULATION_RULE_LIFECYCLE_KEYS = {
58          POPULATION_RULE_ACTIVE_STATE_KEY,
59          POPULATION_RULE_INACTIVE_STATE_KEY
60      };
61  
62      //////////////////////////////////
63      // POPULATION CATEGORY
64      //////////////////////////////////
65  
66      /**
67       * PopulationCategory types
68       */
69      public static final String POPULATION_CATEGORY_TYPE_KEY = "kuali.population.type.population.category";
70  
71      /**
72       * States for Population Category
73       */
74      public static final String POPULATION_CATEGORY_LIFECYCLE_KEY = "kuali.population.population.category.lifecycle";
75      public static final String POPULATION_CATEGORY_ACTIVE_STATE_KEY = "kuali.population.population.category.state.active";
76      public static final String POPULATION_CATEGORY_INACTIVE_STATE_KEY = "kuali.population.population.category.state.inactive";
77      public static final String[] POPULATION_CATEGORY_LIFECYCLE_KEYS = {
78              POPULATION_CATEGORY_ACTIVE_STATE_KEY,
79              POPULATION_CATEGORY_INACTIVE_STATE_KEY
80      };
81  
82      //////////////////////////////////
83      // POPULATION
84      //////////////////////////////////
85  
86      /**
87       * Population types
88       */
89      public static final String POPULATION_TYPE_KEY = "kuali.population.type.population";
90      public static final String POPULATION_STUDENT_TYPE_KEY = "kuali.population.type.student";
91  
92      /**
93       * States for Populations
94       */
95      public static final String POPULATION_LIFECYCLE_KEY = "kuali.population.population.lifecycle";
96      public static final String POPULATION_ACTIVE_STATE_KEY = "kuali.population.population.state.active";
97      public static final String POPULATION_INACTIVE_STATE_KEY = "kuali.population.population.state.inactive";
98      public static final String[] POPULATION_LIFECYCLE_KEYS = {
99          POPULATION_ACTIVE_STATE_KEY,
100         POPULATION_INACTIVE_STATE_KEY
101     };
102 
103     /**
104      * known population keys
105      */
106     public static final String SUMMER_ONLY_STUDENTS_POPULATION_KEY = "kuali.population.summer.only.student";
107     public static final String EVERYONE_POPULATION_KEY = "kuali.population.everyone";
108 }