View Javadoc

1   /**
2    * Copyright 2005-2012 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  package org.kuali.rice.core.api;
17  
18  /**
19   * This class contains constants used by the core module. They are public to all and both clients 
20   * and other rice modules are allowed to use them. 
21   *
22   * @author Kuali Rice Team (rice.collab@kuali.org)
23   *
24   */
25  public final class CoreConstants {
26  
27      public static final class Services {
28          public static final String DATETIME_SERVICE = "dateTimeService";
29          public static final String ENCRYPTION_SERVICE = "encryptionService";
30          public static final String MAILER = "mailer";
31  
32          private Services() {
33      		throw new UnsupportedOperationException("do not call");
34      	}
35  	}
36  
37      public final static String SERVICE_PATH_SOAP = "soap/" + Namespaces.MODULE_NAME + "/" + Versions.VERSION_2_0;
38      
39      public static final class Versions {
40      	    	
41      	public static final String UNSPECIFIED = "unspecifiedVersion";
42      	
43      	/**
44      	 * 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.
45      	 * This constant value should never be changed!  If it is changed then it will break compatibility with legacy clients.
46      	 */
47      	public static final String VERSION_2_0 = "v2_0";
48      	
49      }
50      
51      public static final class Namespaces {
52      	public static final String ROOT_NAMESPACE_PREFIX = "http://rice.kuali.org";
53          public static final String MODULE_NAME = "core";
54          public static final String CORE_NAMESPACE_PREFIX = CoreConstants.Namespaces.ROOT_NAMESPACE_PREFIX + "/" + MODULE_NAME;
55  
56          public static final String UNSPECIFIED = "unspecifiedNamespace";
57  
58      	/**
59      	 * Namespace for the core module which is compatible with Kuali Rice 2.0.x.
60      	 */
61      	public static final String CORE_NAMESPACE_2_0 = CORE_NAMESPACE_PREFIX + "/" + Versions.VERSION_2_0;
62  
63          private Namespaces() {
64  		    throw new UnsupportedOperationException("do not call");
65  	    }
66      }
67      
68      public static final String CORE_SERVICE_DISTRIBUTED_CACHE = "coreServiceDistributedCacheManager";
69  
70      public static final class CommonElements {
71          public static final String FUTURE_ELEMENTS = "_futureElements";
72          public static final String VERSION_NUMBER = "versionNumber";
73          public static final String OBJECT_ID = "objectId";
74          public static final String ACTIVE = "active";
75          public static final String ACTIVE_FROM_DATE = "activeFromDate";
76          public static final String ACTIVE_TO_DATE = "activeToDate";
77          public static final String ATTRIBUTES = "attributes";
78  
79          private CommonElements() {
80  		    throw new UnsupportedOperationException("do not call");
81  	    }
82      }
83  	
84  	public static final String STRING_TO_DATE_FORMATS = "STRING_TO_DATE_FORMATS";
85      public static final String STRING_TO_TIMESTAMP_FORMATS = "STRING_TO_TIMESTAMP_FORMATS";
86      public static final String DATE_TO_STRING_FORMAT_FOR_USER_INTERFACE = "DATE_TO_STRING_FORMAT_FOR_USER_INTERFACE";
87      public static final String TIMESTAMP_TO_STRING_FORMAT_FOR_USER_INTERFACE = "TIMESTAMP_TO_STRING_FORMAT_FOR_USER_INTERFACE";
88      public static final String DATE_TO_STRING_FORMAT_FOR_FILE_NAME = "DATE_TO_STRING_FORMAT_FOR_FILE_NAME";
89      public static final String TIMESTAMP_TO_STRING_FORMAT_FOR_FILE_NAME = "TIMESTAMP_TO_STRING_FORMAT_FOR_FILE_NAME";
90  
91      public static final String DATA_TYPE_STRING = "string";
92      public static final String DATA_TYPE_DATE = "datetime";
93      public static final String DATA_TYPE_LONG = "long";
94      public static final String DATA_TYPE_FLOAT = "float";
95      public static final String DATA_TYPE_BOOLEAN = "boolean";
96      public static final String EMPTY_STRING = "";
97      
98      public static final class Config {
99      	public static final String APPLICATION_ID = "application.id";
100         //FIXME: this should be a core config property
101         public static final String INSTANCE_ID = "rice.ksb.bus.instanceId";
102     }
103     
104 	private CoreConstants() {
105 		throw new UnsupportedOperationException("do not call");
106 	}
107 }