001    /**
002     * Copyright 2005-2012 The Kuali Foundation
003     *
004     * Licensed under the Educational Community License, Version 2.0 (the "License");
005     * you may not use this file except in compliance with the License.
006     * You may obtain a copy of the License at
007     *
008     * http://www.opensource.org/licenses/ecl2.php
009     *
010     * Unless required by applicable law or agreed to in writing, software
011     * distributed under the License is distributed on an "AS IS" BASIS,
012     * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013     * See the License for the specific language governing permissions and
014     * limitations under the License.
015     */
016    package org.kuali.rice.kim.api.identity.residency;
017    
018    import org.kuali.rice.core.api.mo.common.GloballyUnique;
019    import org.kuali.rice.core.api.mo.common.Identifiable;
020    import org.kuali.rice.core.api.mo.common.Versioned;
021    
022    /**
023     * residency info for a KIM identity
024     * 
025     * @author Kuali Rice Team (kuali-rice@googlegroups.com)
026     *
027     */
028    public interface EntityResidencyContract extends Versioned, GloballyUnique, Identifiable {
029    
030            
031            /**
032         * Gets this {@link EntityResidencyContract}'s identity id.
033         * @return the identity id for this {@link EntityResidencyContract}, or null if none has been assigned.
034         */
035            String getEntityId();
036            
037            /**
038         * Gets this {@link EntityResidencyContract}'s determination method.
039         * @return the determination method for this {@link EntityResidencyContract}, or null if none has been assigned.
040         */
041            String getDeterminationMethod();
042            
043            /**
044         * Gets the state this {@link EntityResidencyContract} is in.
045         * @return the state this {@link EntityResidencyContract} is in, or null if none has been assigned.
046         */
047            String getInState();
048    }