View Javadoc

1   /*
2    * Copyright 2006-2011 The Kuali Foundation
3    *
4    * Licensed under the Educational Community License, Version 2.0 (the "License");
5    * you may not use this file except in compliance with the License.
6    * You may obtain a copy of the License at
7    *
8    * http://www.opensource.org/licenses/ecl2.php
9    *
10   * Unless required by applicable law or agreed to in writing, software
11   * distributed under the License is distributed on an "AS IS" BASIS,
12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13   * See the License for the specific language governing permissions and
14   * limitations under the License.
15   */
16  
17  package org.kuali.rice.core.api;
18  
19  /**
20   * This class contains constants used by the core module. They are public to all and both clients 
21   * and other rice modules are allowed to use them. 
22   *
23   * @author Kuali Rice Team (rice.collab@kuali.org)
24   *
25   */
26  public final class CoreConstants {
27  
28      public static final class Services {
29          public static final String DATETIME_SERVICE = "dateTimeService";
30          public static final String ENCRYPTION_SERVICE = "encryptionService";
31  
32          private Services() {
33      		throw new UnsupportedOperationException("do not call");
34      	}
35  	}
36      
37      public static final class Versions {
38      	    	
39      	public static final String UNSPECIFIED = "unspecified";
40      	
41      	/**
42      	 * Name for major version 2.0 of Kuali Rice which should be used in XML namespaces for data elements compatible with Kuali Rice 2.0.x.
43      	 * This constant value should never be changed!  If it is changed then it will break compatibility with legacy clients.
44      	 */
45      	public static final String VERSION_2_0 = "v2_0";
46      	
47      }
48      
49      public static final class Namespaces {
50      	public static final String ROOT_NAMESPACE_PREFIX = "http://rice.kuali.org";
51      	public static final String CORE_NAMESPACE_PREFIX = CoreConstants.Namespaces.ROOT_NAMESPACE_PREFIX + "/core";
52  
53      	/**
54      	 * Namespace for the core module which is compatible with Kuali Rice 2.0.x.
55      	 */
56      	public static final String CORE_NAMESPACE_2_0 = CORE_NAMESPACE_PREFIX + "/" + Versions.VERSION_2_0;
57  
58          private Namespaces() {
59  		    throw new UnsupportedOperationException("do not call");
60  	    }
61      }
62  
63      public static final class CommonElements {
64          public static final String FUTURE_ELEMENTS = "_futureElements";
65          public static final String VERSION_NUMBER = "versionNumber";
66          public static final String OBJECT_ID = "objectId";
67          public static final String ACTIVE = "active";
68          public static final String ACTIVE_FROM_DATE = "activeFromDate";
69          public static final String ACTIVE_TO_DATE = "activeToDate";
70          public static final String ATTRIBUTES = "attributes";
71  
72          private CommonElements() {
73  		    throw new UnsupportedOperationException("do not call");
74  	    }
75      }
76  	
77  	public static final String STRING_TO_DATE_FORMATS = "STRING_TO_DATE_FORMATS";
78      public static final String STRING_TO_TIMESTAMP_FORMATS = "STRING_TO_TIMESTAMP_FORMATS";
79      public static final String DATE_TO_STRING_FORMAT_FOR_USER_INTERFACE = "DATE_TO_STRING_FORMAT_FOR_USER_INTERFACE";
80      public static final String TIMESTAMP_TO_STRING_FORMAT_FOR_USER_INTERFACE = "TIMESTAMP_TO_STRING_FORMAT_FOR_USER_INTERFACE";
81      public static final String DATE_TO_STRING_FORMAT_FOR_FILE_NAME = "DATE_TO_STRING_FORMAT_FOR_FILE_NAME";
82      public static final String TIMESTAMP_TO_STRING_FORMAT_FOR_FILE_NAME = "TIMESTAMP_TO_STRING_FORMAT_FOR_FILE_NAME";
83      
84      public static final class Config {
85      	public static final String APPLICATION_ID = "application.id";
86      }
87      
88  	private CoreConstants() {
89  		throw new UnsupportedOperationException("do not call");
90  	}
91  }