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