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.krms.api.repository.context;
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.agenda.AgendaDefinitionContract;
21
22 import java.util.List;
23 import java.util.Map;
24
25 /**
26 * An interface which defines the contract for context definition objects.
27 *
28 * @author Kuali Rice Team (rice.collab@kuali.org)
29 *
30 */
31 public interface ContextDefinitionContract extends Versioned, Identifiable {
32
33 /**
34 * Returns the namespace of the context definition. The combination of
35 * namespace and name represent a unique business key for the context
36 * definition. The namespace should never be null or blank.
37 *
38 * @return the namespace of the context definition, should never be null or blank
39 */
40 String getNamespace();
41
42 /**
43 * Returns the name of the context definition. The combination of name and namespaceCode
44 * represent a unique business key for the context definition. The name should never be
45 * null or blank.
46 *
47 * @return the name of the context definition, should never be null or blank
48 */
49 String getName();
50
51 /**
52 * Returns the type id for the context definition. If the type id is null, that means
53 * this context definition is of the default type.
54 *
55 * @return the type id for the context definition, or null if this context definition is of the default type
56 */
57 String getTypeId();
58
59
60 /**
61 * Returns the description of the context definition.
62 *
63 * @return the description of the context definition. May be null.
64 */
65 String getDescription();
66
67 // TODO: this java doc is confusing
68 /**
69 * Returns the list of agendas contained within the context definition.
70 * This method should never return null but can return null.
71 *
72 * @return the set of agendas on the context definition
73 */
74 List<? extends AgendaDefinitionContract> getAgendas();
75
76 /**
77 * This method returns a list of attributes associated with the
78 * a context.
79 *
80 * @return a list of AgendaAttribute objects.
81 */
82 public Map<String, String> getAttributes();
83
84 }