001    /**
002     * Copyright 2005-2013 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.location.framework.postalcode;
017    
018    import org.kuali.rice.core.api.mo.common.active.MutableInactivatable;
019    import org.kuali.rice.krad.bo.ExternalizableBusinessObject;
020    import org.kuali.rice.location.api.postalcode.PostalCodeContract;
021    
022    /**
023     * TODO: Likely should remove all methods from this interface after KULRICE-7170 is fixed
024     */
025    public interface PostalCodeEbo extends PostalCodeContract, ExternalizableBusinessObject, MutableInactivatable {
026    
027        /**
028         * This the postal country code for the PostalCode.  This cannot be null or a blank string.
029         *
030         * @return postal country code
031         */
032        String getCountryCode();
033    
034        /**
035         * This the postal state code for the PostalCode.  This can be null.
036         *
037         * @return postal state code
038         */
039        String getStateCode();
040    
041        /**
042         * This the postal state code for the PostalCode.  This can be null.
043         *
044         * @return postal state code
045         */
046        String getCityName();
047    
048        /**
049         * This the county code for the PostalCode.  This cannot be null.
050         *
051         * @return postal state code
052         */
053        String getCountyCode();
054        
055        /**
056         * The code value for this object.  In general a code value cannot be null or a blank string.
057         *
058         * @return the code value for this object.
059         */
060        String getCode();
061        
062        /**
063         * Returns the version number for this object.  In general, this value should only
064         * be null if the object has not yet been stored to a persistent data store.
065         * This version number is generally used for the purposes of optimistic locking.
066         * 
067         * @return the version number, or null if one has not been assigned yet
068         */
069        Long getVersionNumber();
070        
071        
072        /**
073         * The active indicator for an object.
074         *
075         * @return true if active false if not.
076         */
077        boolean isActive();
078        
079        /**
080         * Sets the record to active or inactive.
081         */
082        void setActive(boolean active);
083    }