1 /*
2 * Copyright 2007-2009 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.bo.entity;
17
18
19 /**
20 * residency info for a KIM entity
21 *
22 * @author Kuali Rice Team (kuali-rice@googlegroups.com)
23 *
24 */
25 public interface KimEntityResidency {
26
27 /**
28 * Gets this {@link KimEntityResidency}'s id.
29 * @return the id for this {@link KimEntityResidency}, or null if none has been assigned.
30 */
31 String getId();
32
33 /**
34 * Gets this {@link KimEntityResidency}'s entity id.
35 * @return the entity id for this {@link KimEntityResidency}, or null if none has been assigned.
36 */
37 String getEntityId();
38
39 /**
40 * Gets this {@link KimEntityResidency}'s determination method.
41 * @return the determination method for this {@link KimEntityResidency}, or null if none has been assigned.
42 */
43 String getDeterminationMethod();
44
45 /**
46 * Gets the state this {@link KimEntityResidency} is in.
47 * @return the state this {@link KimEntityResidency} is in, or null if none has been assigned.
48 */
49 String getInState();
50 }