01: /*
02: * Copyright 2005-2006 The Kuali Foundation.
03: *
04: * Licensed under the Educational Community License, Version 1.0 (the "License");
05: * you may not use this file except in compliance with the License.
06: * You may obtain a copy of the License at
07: *
08: * http://www.opensource.org/licenses/ecl1.php
09: *
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:
17: package org.kuali.core.datadictionary;
18:
19: import java.io.Serializable;
20: import java.util.Map;
21:
22: /**
23: * Defines methods common to all DataDictionaryDefinition types.
24: *
25: *
26: */
27: public interface DataDictionaryEntry extends Serializable {
28: /**
29: * @return String used as a globally-unique key for this entry's jstl-exported version
30: */
31: public String getJstlKey();
32:
33: /**
34: * Kicks off complete entry-wide validation which couldn't be done earlier.
35: *
36: * @throws org.kuali.core.datadictionary.exception.CompletionException if a problem arises during validation-completion
37: */
38: public void completeValidation(
39: ValidationCompletionUtils validationCompletionUtils);
40:
41: /**
42: * @param attributeName
43: * @return AttributeDefinition with the given name, or null if none with that name exists
44: */
45: public AttributeDefinition getAttributeDefinition(
46: String attributeName);
47:
48: /**
49: * Returns the full class name of the underlying object.
50: */
51: public String getFullClassName();
52:
53: /**
54: * @return a Map containing all RelationshipDefinitions associated with this BusinessObjectEntry, indexed by relationshipName
55: */
56: public Map<String, RelationshipDefinition> getRelationships();
57: }
|