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      public static final String[] POPULATION_RULE_TYPE_KEYS = {
52              PopulationServiceConstants.POPULATION_RULE_TYPE_RULE_KEY,
53              PopulationServiceConstants.POPULATION_RULE_TYPE_PERSON_KEY,
54              PopulationServiceConstants.POPULATION_RULE_TYPE_SEARCH_KEY,
55              PopulationServiceConstants.POPULATION_RULE_TYPE_UNION_KEY,
56              PopulationServiceConstants.POPULATION_RULE_TYPE_INTERSECTION_KEY,
57              PopulationServiceConstants.POPULATION_RULE_TYPE_EXCLUSION_KEY
58      };
59  
60      /**
61       * States for Population Rule
62       */
63      public static final String POPULATION_RULE_LIFECYCLE_KEY = "kuali.population.population.rule.lifecycle";
64      public static final String POPULATION_RULE_ACTIVE_STATE_KEY = "kuali.population.population.rule.state.active";
65      public static final String POPULATION_RULE_INACTIVE_STATE_KEY = "kuali.population.population.rule.state.inactive";
66      public static final String[] POPULATION_RULE_LIFECYCLE_KEYS = {
67          POPULATION_RULE_ACTIVE_STATE_KEY,
68          POPULATION_RULE_INACTIVE_STATE_KEY
69      };
70  
71      //////////////////////////////////
72      // POPULATION CATEGORY
73      //////////////////////////////////
74  
75      /**
76       * PopulationCategory types
77       */
78      public static final String POPULATION_CATEGORY_TYPE_KEY = "kuali.population.type.population.category";
79  
80      /**
81       * States for Population Category
82       */
83      public static final String POPULATION_CATEGORY_LIFECYCLE_KEY = "kuali.population.population.category.lifecycle";
84      public static final String POPULATION_CATEGORY_ACTIVE_STATE_KEY = "kuali.population.population.category.state.active";
85      public static final String POPULATION_CATEGORY_INACTIVE_STATE_KEY = "kuali.population.population.category.state.inactive";
86      public static final String[] POPULATION_CATEGORY_LIFECYCLE_KEYS = {
87              POPULATION_CATEGORY_ACTIVE_STATE_KEY,
88              POPULATION_CATEGORY_INACTIVE_STATE_KEY
89      };
90  
91      //////////////////////////////////
92      // POPULATION
93      //////////////////////////////////
94  
95      /**
96       * Population types
97       */
98      public static final String POPULATION_TYPE_KEY = "kuali.population.type.population";
99      public static final String POPULATION_STUDENT_TYPE_KEY = "kuali.population.type.student";
100 
101     /**
102      * States for Populations
103      */
104     public static final String POPULATION_LIFECYCLE_KEY = "kuali.population.population.lifecycle";
105     public static final String POPULATION_ACTIVE_STATE_KEY = "kuali.population.population.state.active";
106     public static final String POPULATION_INACTIVE_STATE_KEY = "kuali.population.population.state.inactive";
107     public static final String[] POPULATION_LIFECYCLE_KEYS = {
108         POPULATION_ACTIVE_STATE_KEY,
109         POPULATION_INACTIVE_STATE_KEY
110     };
111 
112     /**
113      * known population keys
114      */
115     public static final String SUMMER_ONLY_STUDENTS_POPULATION_KEY = "kuali.population.summer.only.student";
116     public static final String EVERYONE_POPULATION_KEY = "kuali.population.everyone";
117 }