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.kim.api.identity.residency;
17
18 import org.kuali.rice.core.api.mo.common.GloballyUnique;
19 import org.kuali.rice.core.api.mo.common.Identifiable;
20 import org.kuali.rice.core.api.mo.common.Versioned;
21
22 /**
23 * residency info for a KIM identity
24 *
25 * @author Kuali Rice Team (kuali-rice@googlegroups.com)
26 *
27 */
28 public interface EntityResidencyContract extends Versioned, GloballyUnique, Identifiable {
29
30
31 /**
32 * Gets this {@link EntityResidencyContract}'s identity id.
33 * @return the identity id for this {@link EntityResidencyContract}, or null if none has been assigned.
34 */
35 String getEntityId();
36
37 /**
38 * Gets this {@link EntityResidencyContract}'s determination method.
39 * @return the determination method for this {@link EntityResidencyContract}, or null if none has been assigned.
40 */
41 String getDeterminationMethod();
42
43 /**
44 * Gets the state this {@link EntityResidencyContract} is in.
45 * @return the state this {@link EntityResidencyContract} is in, or null if none has been assigned.
46 */
47 String getInState();
48 }