Classes in this File | Line Coverage | Branch Coverage | Complexity | ||||
TermSpecificationDefinitionContract |
|
| 1.0;1 |
1 | /* | |
2 | * Copyright 2011 The Kuali Foundation | |
3 | * | |
4 | * Licensed under the Educational Community License, Version 1.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/ecl1.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.krms.api.repository.term; | |
17 | ||
18 | import org.kuali.rice.core.api.mo.common.Identifiable; | |
19 | import org.kuali.rice.core.api.mo.common.Versioned; | |
20 | import org.kuali.rice.krms.api.repository.category.CategoryDefinitionContract; | |
21 | ||
22 | import java.util.List; | |
23 | ||
24 | /** | |
25 | * Interface for classes specifying term specifications | |
26 | * | |
27 | * @author Kuali Rice Team (rice.collab@kuali.org) | |
28 | * | |
29 | */ | |
30 | public interface TermSpecificationDefinitionContract extends Identifiable, Versioned { | |
31 | ||
32 | /** | |
33 | * @return the unique id for the context that this {@link TermSpecificationDefinitionContract} is associated with. | |
34 | */ | |
35 | String getContextId(); | |
36 | ||
37 | /** | |
38 | * @return the name for this {@link TermSpecificationDefinitionContract} | |
39 | */ | |
40 | String getName(); | |
41 | ||
42 | /** | |
43 | * @return the fully qualified class name for this {@link TermSpecificationDefinitionContract} | |
44 | */ | |
45 | String getType(); | |
46 | ||
47 | /** | |
48 | * @return the description for this {@link TermSpecificationDefinitionContract} | |
49 | */ | |
50 | String getDescription(); | |
51 | ||
52 | /** | |
53 | * Returns an ordered, immutable list of the categories which this term specification | |
54 | * definition requires. This list can be empty (in the case of a term | |
55 | * which has no arguments) but will never be null. | |
56 | * | |
57 | * @return the list of categories for this term specification definition | |
58 | */ | |
59 | List<? extends CategoryDefinitionContract> getCategories(); | |
60 | ||
61 | } |