1 /**
2 * Copyright 2005-2014 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.krad.data.metadata.impl;
17
18 import org.kuali.rice.krad.data.metadata.MetadataCommon;
19
20 /**
21 * Interface implemented by the classes within the provider, but that we don't want to expose to use outside of the
22 * krad-data module.
23 *
24 * @author Kuali Rice Team (rice.collab@kuali.org)
25 */
26 public interface MetadataCommonInternal extends MetadataCommon {
27 /**
28 * If this data object instance is wrapping another (generated by a lower metadata provider), return that.
29 *
30 * Returns null if this instance is not wrapping another.
31 */
32 MetadataCommon getEmbeddedCommonMetadata();
33
34 void setEmbeddedCommonMetadata(MetadataCommon embeddedCommonMetadata);
35
36 /**
37 * An object representing the object for purposes of merging. This should return an attribute name or a unique data
38 * type object.
39 *
40 * Whatever the class, it must have proper hashCode() and equals() semantics and not rely on object identity.
41 *
42 * This method must not return null;
43 */
44 Object getUniqueKeyForMerging();
45
46 }