View Javadoc

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.krms.api.repository.reference;
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.core.api.mo.common.active.Inactivatable;
21  
22  /**
23   * Defines the contract for a {@link ReferenceObjectBinding}
24   *
25   * @see ReferenceObjectBinding
26   *
27   * @author Kuali Rice Team (rice.collab@kuali.org)
28   */
29  public interface ReferenceObjectBindingContract extends Identifiable, Inactivatable, Versioned {
30      /**
31       * This is the CollectionName of the ReferenceObjectBinding
32       * <p>
33       * The CollectionName of the ReferenceObjectBinding
34       * </p>
35       * @return the CollectionName of the ReferenceObjectBinding
36       */
37      public String getCollectionName();
38  
39      /**
40       * This is the KrmsDiscriminatorType of the ReferenceObjectBinding
41       * <p>
42       * The KrmsDiscriminatorType of the ReferenceObjectBinding
43       * </p>
44       * @return the KrmsDiscriminatorType of the ReferenceObjectBinding
45       */
46      public String getKrmsDiscriminatorType();
47  
48      /**
49       * This is the KrmsObjectId of the ReferenceObjectBinding
50       * <p>
51       * The KrmsObjectId of the ReferenceObjectBinding
52       * </p>
53       * @return the KrmsObjectId of the ReferenceObjectBinding
54       */
55      public String getKrmsObjectId();
56  
57      /**
58       * This is the namespace of the ReferenceObjectBinding
59       * <p>
60       * The namespace of the ReferenceObjectBinding
61       * </p>
62       * @return the namespace of the ReferenceObjectBinding
63       */
64      public String getNamespace();
65  
66      /**
67       * This is the ReferenceDiscriminatorType of the ReferenceObjectBinding
68       * <p>
69       * The ReferenceDiscriminatorType of the ReferenceObjectBinding
70       * </p>
71       * @return the ReferenceDiscriminatorType of the ReferenceObjectBinding
72       */
73      public String getReferenceDiscriminatorType();
74  
75      /**
76       * This is the ReferenceObjectId of the ReferenceObjectBinding
77       * <p>
78       * The ReferenceObjectId of the ReferenceObjectBinding
79       * </p>
80       * @return the ReferenceObjectId of the ReferenceObjectBinding
81       */
82      public String getReferenceObjectId();
83  
84  
85  }