1 /**
2 * Copyright 2005-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 package org.kuali.rice.core.api.namespace;
17
18 import org.kuali.rice.core.api.mo.common.Coded;
19 import org.kuali.rice.core.api.mo.common.GloballyUnique;
20 import org.kuali.rice.core.api.mo.common.Versioned;
21 import org.kuali.rice.core.api.mo.common.active.Inactivatable;
22
23 /**
24 * Defines the contract for a Namespace. A namespace is a mechanism for partitioning of data into
25 * areas of responsibility. Since much of the Kuali Rice middleware is shared across multiple integrating
26 * applications, this notion of a namespace is a critical element in keeping related data elements
27 * grouped together and isolated from those to which they should have no relation or access.
28 */
29 public interface NamespaceContract extends Versioned, GloballyUnique, Inactivatable, Coded {
30
31 /**
32 * This the id of the application which owns this Namespace. This cannot be null or a blank string.
33 *
34 * <p>
35 * It is a way of assigning the Namespace to a specific rice application or rice ecosystem.
36 * </p>
37 *
38 * @return application id
39 */
40 String getApplicationId();
41
42 /**
43 * This the name for the Namespace. This can be null or a blank string.
44 *
45 * @return name
46 */
47 String getName();
48 }