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.coreservice.api.component;
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 * This is the contract for a Component. This represents functional/logical piece
25 * within a rice application or rice ecosystem.
26 */
27 public interface ComponentContract extends Versioned, GloballyUnique, Inactivatable, Coded {
28
29 /**
30 * This is the name value for the component. It cannot be null or a blank string.
31 * @return name
32 */
33 String getName();
34
35 /**
36 * This is the namespace for the component. It cannot be null or a blank string.
37 * <p>
38 * It is a way of assigning the component to a logical grouping within a rice application or rice ecosystem.
39 * </p>
40 *
41 * @return namespace code
42 */
43 String getNamespaceCode();
44
45 /**
46 * Returns the id of the component set this component belongs to if this component was published as part of such
47 * a component set. Will return a null value if this component was not published as part of a component set.
48 *
49 * @return the id of the component set this component was published under, or null if this component is not part of
50 * a published set
51 */
52 String getComponentSetId();
53
54
55 }