001/**
002 * Copyright 2005-2016 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 */
016package org.kuali.rice.kim.framework.identity.citizenship;
017
018import org.kuali.rice.kim.api.identity.CodedAttributeContract;
019import org.kuali.rice.krad.bo.ExternalizableBusinessObject;
020
021/**
022 * TODO: Likely should remove all methods from this interface after KULRICE-7170 is fixed
023 */
024public interface EntityCitizenshipStatusEbo extends CodedAttributeContract, ExternalizableBusinessObject {
025    
026    /**
027     * This the name for the AddressType.  This can be null or a blank string.
028     *
029     * @return the name of the AddressType
030     */
031    String getName();
032
033    /**
034     * This the sort code for the AddressType.  This can be null or a blank string.
035     *
036     * @return the sort code of the AddressType
037     */
038    String getSortCode();
039    
040    /**
041     * Returns the version number for this object.  In general, this value should only
042     * be null if the object has not yet been stored to a persistent data store.
043     * This version number is generally used for the purposes of optimistic locking.
044     * 
045     * @return the version number, or null if one has not been assigned yet
046     */
047    Long getVersionNumber();
048    
049    /**
050     * Return the globally unique object id of this object.  In general, this value should only
051     * be null if the object has not yet been stored to a persistent data store.
052     * 
053     * @return the objectId of this object, or null if it has not been set yet
054     */
055    String getObjectId();
056    
057    /**
058     * The active indicator for an object.
059     *
060     * @return true if active false if not.
061     */
062    boolean isActive();
063    
064    /**
065     * The code value for this object.  In general a code value cannot be null or a blank string.
066     *
067     * @return the code value for this object.
068     */
069    String getCode();
070}