Classes in this File | Line Coverage | Branch Coverage | Complexity | ||||
NamespaceContract |
|
| 1.0;1 |
1 | package org.kuali.rice.core.api.namespace; | |
2 | ||
3 | import org.kuali.rice.core.api.mo.common.Coded; | |
4 | import org.kuali.rice.core.api.mo.common.GloballyUnique; | |
5 | import org.kuali.rice.core.api.mo.common.Versioned; | |
6 | import org.kuali.rice.core.api.mo.common.active.Inactivatable; | |
7 | ||
8 | /** | |
9 | * Defines the contract for a Namespace. A namespace is a mechanism for partitioning of data into | |
10 | * areas of responsibility. Since much of the Kuali Rice middleware is shared across multiple integrating | |
11 | * applications, this notion of a namespace is a critical element in keeping related data elements | |
12 | * grouped together and isolated from those to which they should have no relation or access. | |
13 | */ | |
14 | public interface NamespaceContract extends Versioned, GloballyUnique, Inactivatable, Coded { | |
15 | ||
16 | /** | |
17 | * This the id of the application which owns this Namespace. This cannot be null or a blank string. | |
18 | * | |
19 | * <p> | |
20 | * It is a way of assigning the Namespace to a specific rice application or rice ecosystem. | |
21 | * </p> | |
22 | * | |
23 | * @return application id | |
24 | */ | |
25 | String getApplicationId(); | |
26 | ||
27 | /** | |
28 | * This the name for the Namespace. This can be null or a blank string. | |
29 | * | |
30 | * @return name | |
31 | */ | |
32 | String getName(); | |
33 | } |